Go има инструмент за извличане на документация - godoc.

Конвенцията

Коментар преди всеки елемент, който искаме да опишем в документацията.

//BUG(pesho) the onions Onion() gives are not real.

// Пакет за пълноценно хранене.
// https://www.billa.bg/
package groceries

// Onion връща лук.
func Onion() onion{

   // o - лукът o.
   var o onion

   return o
}

HTML линкове се маркират автоматично като такива в документацията.

Взимат се предвид само коментари непосредствено преди пакет, тип, променлива, или функция (може би и други). Вградено изключение е BUG - всеки коментар, започващ с BUG, се запазва, като в скобите се пише username на човека, който знае повече за бъга. Възможно е да се дефинират допълнителни "ключови думи" чрез флаговете.

Относно godoc, за конвенцията, вижте КОНВЕНЦИЯ. За флаговете и самия инструмент, вижте ФЛАГОВЕ.

GoDoc.org

GoDoc.org е host за документация на Go пакети от външни източници.

Официалната документация на Go е на сайта на Go, като се спазва "workspace" конвенцията - http://golang.org/pkg/groceries.

---

Поздрави и приятно документиране!