Комментарии пакета, как и все комментарии, чтобы быть представленными посредством godoc, должны появляться рядом с package вызовом без пустой строки.
// Пакет math предоставляет основные константы
// и математические функции.
package math
/*
Пакет template реализует управляемые данными шаблоны
для создания текстового вывода, такого как HTML.
....
*/
package template
Для "package main" комментариев другие стили комментария подходят после двойного имени (и оно может быть написано заглавными буквами, если оно идет первым), например, для пакета main в каталоге seedgen вы можете написать:
// Binary seedgen ...
package main
или
// Command seedgen ...
package main
или
// Program seedgen ...
package main
или
// The seedgen command ...
package main
или
// The seedgen program ...
package main
или
// Seedgen ...
package main
Это только примеры, и вполне приемлемы другие их варианты.
Обратите внимание, что начало предложения со слова в нижнем регистре не относится к числу приемлемых вариантов комментариев пакета, поскольку они являются общедоступными и должны быть написаны на надлежащем английском языке, включая использование заглавных букв в первом слове предложения. Когда двойное имя является первым словом, оно должно быть написано заглавными буквами, даже если оно не полностью соответствует написанию вызова командной строки.
Читайте также:
Комментариев нет:
Отправить комментарий