Hienoa, nyt tiedän mistä löydän dokumentit ja miten niitä luetaan. Seuraava kysymykseni on: Voinko luoda tällaisen dokumentaation myös omalle koodilleni ja miten dokumentoin koodini? Tarkoitan, että kun minulla on seuraava koodi:

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

Miten luon dokumentaation vain tästä package ja function:stä?

Muoto

Kuten löysin tästä blogikirjoituksesta, näyttää siltä, että koodin dokumentoimiseen ei ole ”mitään erityistä muotoa”. Verrattuna JavaDociin, joka ottaa käyttöön uusia asioita kuten @link tai @see. Kun haluat dokumentoida koodia sinun tarvitsee vain luoda ”yksinkertaisia kommentteja”. Mitä teet joka tapauksessa kirjoittaessasi go-koodia.

Näyttää siltä, että ainoa vaatimus on, että ensimmäinen sana on funktion nimi. Tai Package kun dokumentoit 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
}

Generoi dokumentti

Pahoittelen, mutta dokumenttia ei voi generoida! Tai ei ainakaan haluamallani tavalla. Oletin, että voin luoda dokumentaation HTML-muodossa, joka kuvaa vain projektini. Mutta voit luoda dokumentaation vain kaikista go-tiedostoistasi GOROOT ja GOPATH.

Luotan myöhemmin toisen postauksen GOPATH:sta, koska se on tärkeä asia go:ssa. Mutta nyt vain oletetaan, että tämä on paikka kiintolevylläsi, johon tallennat kaikki go-tiedostosi.

Mutta takaisin dokumentaatioon. Voit luoda sellaisen godoc-työkalulla. Voit ajaa godoc -http=:6060, joka käynnistää web-palvelimen localhostissa portissa 6060, josta näet ”dokumentit”.