godoc - Интернет в облаке

ПРОГРАММА:

ИМЯ

godoc - извлекает и генерирует документацию для программ Go

СИНТАКСИС

Годок [флажок] команда [ имя ... ]

ОПИСАНИЕ

Godoc извлекает и создает документацию для программ Go.

Имеет два режима.

Без флага -http он работает в режиме командной строки и печатает текстовую документацию.
на стандартный вывод и выходы. Если и пакет библиотеки, и команда с тем же именем
существует, использование префикса cmd / заставит документацию по команде, а не
пакет библиотеки. Если указан флаг -src, godoc печатает экспортированный интерфейс
пакет в исходной форме Go или реализация конкретной экспортируемой языковой сущности:

godoc fmt # документация для пакета fmt
godoc fmt Printf # документация для fmt.Printf
godoc cmd / go # форсировать документацию для команды go
godoc -src fmt # интерфейс пакета fmt в исходной форме Go
godoc -src fmt Printf # реализация fmt.Printf

В режиме командной строки флаг -q разрешает поисковые запросы к godoc, запущенному как
веб сервер. Если не указан явный адрес сервера с флагом -server, сначала godoc
пробует localhost: 6060, а затем http://golang.org.

godoc -q Читатель
godoc -q math.Sin
godoc -server =: 6060 -q грех

С флагом -http он работает как веб-сервер и представляет документацию в виде веб-страницы.

godoc -http =: 6060

По умолчанию godoc просматривает пакеты, которые он находит через $ GOROOT и $ GOPATH (если установлено).
Дополнительные каталоги могут быть указаны с помощью флага -path, который принимает список двоеточий.
разделенные пути; некорневые пути относятся к текущему рабочему каталогу. Каждый путь
рассматривается как дополнительный корень для пакетов в порядке появления. Последний
(абсолютный) элемент пути - это префикс для пути к пакету. Например, учитывая флаг
значение:

путь = ".: / home / bar: / public"

для godoc, запущенного в / home / user / godoc, абсолютные пути отображаются на пути к пакетам как
следующим образом:

/ главная / пользователь / годок / х -> годок / х
/ главная / бар / х -> бар / х
/ public / x -> public / x

Когда godoc работает как веб-сервер и установлен -index, поддерживается индекс поиска. Индекс
создается при запуске.

Индекс содержит как идентификатор, так и информацию полнотекстового поиска (с возможностью поиска через
регулярные выражения). Максимальное количество отображаемых результатов полнотекстового поиска можно установить с помощью
флаг -maxresults; если установлено значение 0, полнотекстовые результаты не отображаются, а отображается только идентификатор
index, но индекс полнотекстового поиска не создается.

Режимом представления веб-страниц, обслуживаемых godoc, можно управлять с помощью URL-адреса "m".
параметр; он принимает в качестве значения список имен флагов, разделенных запятыми:

ВСЕ показать документацию для всех объявлений, а не только для экспортируемых

методы
показать все встроенные методы, а не только те из неэкспортированных анонимных полей

SRC показывать оригинальный исходный код, а не извлеченную документацию

текст представлять страницу в текстовой (командной строке) форме, а не в HTML

плоский отображать плоские (без отступов) списки каталогов, используя полные пути

Например, http://golang.org/pkg/math/big/? m = all, текст показывает документацию для всех
(а не только экспортированные) объявления большого пакета в текстовой форме (как могло бы показаться
при использовании godoc из командной строки: «godoc -src math / big. *»).

По умолчанию godoc обслуживает файлы из файловой системы базовой ОС. Вместо этого .zip
файл может быть предоставлен с помощью флага -zip, который содержит файловую систему для обслуживания. Файл
пути, хранящиеся в файле .zip, должны использовать косую черту ('/') в качестве разделителя пути; и они должны быть
некорневой. $ GOROOT (или -goroot) должен быть установлен как путь к каталогу файла .zip, содержащего
Перейти в корневой каталог. Например, для файла .zip, созданного командой:

zip go.zip $ HOME / go

можно запустить godoc следующим образом:

godoc -http =: 6060 -zip = go.zip -goroot = $ HOME / go

См. «Godoc: документирование кода Go», чтобы узнать, как писать хорошие комментарии для godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html

ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ

-v подробный режим

-q аргументы считаются поисковыми запросами: юридический запрос - это единственный идентификатор (например,
как ToLower) или квалифицированный идентификатор (например, math.Sin).

-источник распечатать (экспортировать) исходный текст в режиме командной строки

-tabwidth = 4
ширина табуляции в единицах пробелов

-timestamps = истина
показать временные метки со списками каталогов

-индекс включить идентификатор и индекс полнотекстового поиска (поле поиска не отображается, если -index
не задано)

-index_files = ""
шаблон glob, определяющий индексные файлы; если не пустой, индекс читается из этих
файлы в отсортированном порядке

-index_throttle = 0.75
индекс значения дроссельной заслонки; значение 0 означает, что индексатору не выделяется время (
indexer никогда не завершится), значение 1.0 означает, что создание индекса выполняется на
полный газ (другие горутины могут не успевать, пока строится индекс)

-write_index = ложь
записать индекс в файл; имя файла должно быть указано с -index_files

-maxresults = 10000
максимальное количество отображаемых результатов полнотекстового поиска (полнотекстовый индекс не создается, если
maxresults <= 0)

-path = ""
дополнительные каталоги пакетов (через двоеточие)

-html распечатать HTML в режиме командной строки

-goroot = $ GOROOT
Перейти в корневой каталог

-http = адрес
Адрес службы HTTP (например, 127.0.0.1:6060 или просто: 6060)

-server = адрес
адрес веб-сервера для поиска в командной строке

-templates = ""
каталог, содержащий альтернативные файлы шаблонов; если установлено, каталог может предоставлять
альтернативные файлы шаблонов для файлов в $ GOROOT / lib / godoc

-url = путь
вывести на стандартный вывод данные, которые будут обслуживаться HTTP-запросом пути

-zip = ""
zip-файл, предоставляющий файловую систему для обслуживания; отключено, если пусто

Используйте godoc онлайн с помощью сервисов onworks.net