Комментарии, документирующие декларации, должны быть полными предложениями, даже если это кажется немного излишним. Такой подход делает их хорошо отформатированными при извлечении в документацию Godoc. Комментарии должны начинаться с названия описываемой вещи и заканчиваться точкой:
// Request представляет запрос на выполнение команды.
type Request struct { ...
// Encode записывает JSON кодированый req в w.
func Encode(w io.Writer, req *Request) { ...
Читайте также:
- Go FAQ: Существует ли руководство по Go стилю программирования?
- Эффективный Go: комментарии
- Go FAQ: Как документируются библиотеки?
Комментариев нет:
Отправить комментарий