Genial, acum știu unde să găsesc documentația și cum să o citesc. Următoarea mea întrebare este: Pot să creez o astfel de documentație și pentru codul meu și cum îmi documentez codul? Adică, având în vedere că am următorul cod:

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

Cum creez o documentație doar pentru acest package și function?

Formatul

După cum am găsit în această postare pe blog se pare că nu există „un format special” pentru a documenta codul. În comparație cu JavaDoc care introduce lucruri noi precum @link sau @see. Atunci când doriți să documentați codul trebuie doar să creați „comentarii simple”. Ceea ce veți face oricum atunci când vă scrieți codul go.

Se pare că singurul lucru necesar este ca primul cuvânt să fie numele funcției. Sau Package când documentați o 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
}

Generați documentația

Îmi pare rău să vă spun, dar nu puteți genera o documentație! Sau cel puțin nu în modul în care doresc eu. Am presupus că pot crea o documentație în HTML care să descrie doar proiectul meu. Dar puteți crea o documentație doar pentru toate fișierele go din GOROOT și GOPATH.

Voi crea o altă postare despre GOPATH mai târziu, deoarece este un lucru important în go. Dar, deocamdată, presupuneți că acesta este locul de pe hard disk-ul dvs. unde stocați toate fișierele go.

Dar să revenim la documentație. Puteți crea unul cu ajutorul instrumentului godoc. Puteți rula godoc -http=:6060 care va porni un server web pe localhost la portul 6060 unde puteți vedea „the docs”.

.