Skvělé, teď už vím, kde najít dokumenty a jak je číst. Moje další otázka zní: Mohu takovou dokumentaci vytvořit i pro svůj kód a jak mám svůj kód dokumentovat? Tedy vzhledem k tomu, že mám následující kód:

package matherfunc Add(first, second int) int {
return first + second
}

Jak vytvořím dokumentaci právě pro tento kód package a function?

Formát

Jak jsem našel v tomto blogovém příspěvku, zdá se, že „neexistuje žádný speciální formát“ pro dokumentaci kódu. Ve srovnání s JavaDoc, který zavádí nové věci jako @link nebo @see. Když chcete dokumentovat kód, stačí vytvořit „jednoduché komentáře“. Což stejně uděláte, když budete psát svůj go kód.

Zdá se, že jedinou požadovanou věcí je, aby první slovo bylo jméno vaší funkce. Nebo Package když dokumentujete package.

// Package which provides some math methods
package mather// Add the first and second integer together 
// and return it
func Add(first, second int) int {
return first + second
}

Vygenerujte dokumentaci

Mrzí mě to, ale dokumentaci vygenerovat nemůžete! Nebo alespoň ne tak, jak bych chtěl. Předpokládal jsem, že mohu vytvořit dokumentaci v HTML, která popisuje pouze můj projekt. Ale dokumentaci můžete vytvořit pouze pro všechny soubory go v GOROOT a GOPATH.

O GOPATH vytvořím další příspěvek později, protože je to důležitá věc v go. Zatím ale předpokládejte, že je to místo na vašem pevném disku, kam ukládáte všechny soubory go.

Ale zpět k dokumentaci. Můžete si ji vytvořit pomocí nástroje godoc. Můžete spustit godoc -http=:6060, který spustí webový server na vašem localhostu na portu 6060, kde uvidíte „dokumentaci“.

.