Рубрики
go

014 / go doc

Введите команду "go doc", чтобы вывести документацию по любому пакету или функции.
Чтобы вывести документацию по пакету, передайте его путь импорта команде "go doc". 
Например, информация о пакете "strconv" выводится командой "go doc strconv".
 
go doc -h
 
go doc -u http
 
go doc strconv
 
go doc strconv ParseFloat
 
go doc github.com/headfirstgo/keyboard
 
Команда go doc старается получить полезную информацию на основании анализа кода. 
Имена пакетов и пути импорта включаются автоматически, как и имена функций, параметры и возвращаемые типы. 
И все же команда go doc не умеет творить чудеса. 
Если вы хотите, чтобы пользователи смогли узнать из документации о предназначении пакета или функции, 
придется добавить эту информацию самостоятельно.
 
К счастью, это делается просто: нужно добавить в код документирующие комментарии. 
Обычные комментарии Go, размещенные непосредственно перед директивой package или объявлением функции, 
считаются документирующими комментариями и включаются в вывод go doc.
 
 
При добавлении документирующих комментариев следует соблюдать ряд правил:
- Комментарии должны состоять из полноценных предложений.
- Комментарии для пакетов должны начинаться со слова "Package", за которым следует имя пакета:
// Package mypackage enables widget management.
- Комментарии для функций должны начинаться с имени функции, которую они описывают:
// MyFunction converts widgets to gizmos.
- В комментарии также можно включать примеры кода, которые должны снабжаться отступами.
- Не включайте дополнительные символы для выразительности или форматирования (кроме отступов в примерах кода). 
  Документирующие комментарии будут выводиться в виде простого текста и должны форматироваться соответствующим образом.


go help
go help gopath
go help list