Génial, maintenant je sais où trouver les docs et comment les lire. Ma prochaine question est : puis-je créer une telle documentation pour mon code également et comment documenter mon code ? Je veux dire, étant donné que j’ai le code suivant:

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

Comment puis-je créer une documentation juste pour ce package et function?

Le format

Comme je l’ai trouvé dans cet article de blog, il semble qu’il n’y ait « aucun format spécial » pour documenter le code. Par rapport à la JavaDoc qui introduit de nouvelles choses comme @link ou @see. Lorsque vous voulez documenter du code, il vous suffit de créer de « simples commentaires ». Ce que vous ferez de toute façon lorsque vous écrirez votre code go.

Il semble que la seule chose requise est que le premier mot doit être le nom de votre fonction. Ou Packagelorsque vous documentez une 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
}

Générer la doc

Désolé de le dire, mais vous ne pouvez pas générer une documentation ! Ou du moins pas de la manière dont je le souhaite. J’ai supposé que je pouvais créer une documentation en HTML qui décrit uniquement mon projet. Mais vous ne pouvez créer une documentation que pour tous les fichiers go dans votre GOROOT et GOPATH.

Je créerai un autre post sur le GOPATH plus tard car c’est une chose importante dans go. Mais pour l’instant, supposez simplement que c’est l’endroit sur votre disque dur où vous stockez tous vos fichiers go.

Mais revenons à la documentation. Vous pouvez en créer un avec l’outil godoc. Vous pouvez exécuter godoc -http=:6060 qui démarrera un serveur web sur votre localhost au port 6060 où vous pourrez voir « la docs ».