godoc - En ligne dans le Cloud

PROGRAMME:

Nom

godoc - extrait et génère la documentation des programmes Go

SYNOPSIS

godoc [drapeau] commande [ prénom ... ]

DESCRIPTION

Godoc extrait et génère la documentation des programmes Go.

Il dispose de deux modes.

Sans l'indicateur -http, il s'exécute en mode ligne de commande et imprime la documentation en texte brut
vers la sortie standard et quitte. Si un paquet de bibliothèque et une commande portent le même nom,
existe, l'utilisation du préfixe cmd/ forcera la documentation sur la commande plutôt que sur la
paquet de bibliothèque. Si l'option -src est spécifiée, godoc affiche l'interface exportée d'un
package sous forme de source Go, ou l'implémentation d'une entité de langage exportée spécifique :

godoc fmt # documentation pour le paquet fmt
godoc fmt Printf # documentation pour fmt.Printf
godoc cmd/go # force la documentation pour la commande go
godoc -src fmt # interface du package fmt sous forme de source Go
godoc -src fmt Printf # implémentation de fmt.Printf

En mode ligne de commande, l'indicateur -q active les requêtes de recherche sur un godoc exécuté en tant que
Serveur web. Si aucune adresse de serveur n'est spécifiée avec l'option -server, godoc est d'abord exécuté.
essaie localhost:6060 puis http://golang.org.

lecteur godoc -q
godoc -q math.Sin
godoc -server=:6060 -q sin

Avec l'indicateur -http, il fonctionne comme un serveur Web et présente la documentation sous forme de page Web.

godoc -http=:6060

Par défaut, godoc examine les packages qu'il trouve via $GOROOT et $GOPATH (si défini).
Des répertoires supplémentaires peuvent être spécifiés via l'indicateur -path qui accepte une liste de deux-points.
Chemins séparés ; les chemins non enracinés sont relatifs au répertoire de travail courant. Chaque chemin
est considéré comme une racine supplémentaire pour les paquets par ordre d'apparition. Le dernier
L'élément de chemin (absolu) est le préfixe du chemin du paquet. Par exemple, si l'indicateur est
valeur:

chemin=".:/home/bar:/public"

pour un godoc démarré dans /home/user/godoc, les chemins absolus sont mappés aux chemins des packages comme
suit:

/home/utilisateur/godoc/x -> godoc/x
/home/bar/x -> bar/x
/public/x -> public/x

Lorsque godoc s'exécute en tant que serveur Web et que l'option -index est définie, un index de recherche est maintenu. L'index
est créé au démarrage.

L'index contient à la fois des identifiants et des informations de recherche en texte intégral (consultables via
expressions régulières). Le nombre maximal de résultats de recherche en texte intégral affichés peut être défini avec
l'indicateur -maxresults ; s'il est défini sur 0, aucun résultat en texte intégral n'est affiché, et seul un identifiant
index mais aucun index de recherche de texte intégral n'est créé.

Le mode de présentation des pages Web servies par godoc peut être contrôlé avec l'URL « m »
paramètre ; il accepte une liste de noms d'indicateurs séparés par des virgules comme valeur :

tous afficher la documentation pour toutes les déclarations, pas seulement celles exportées

méthodes
afficher toutes les méthodes intégrées, pas seulement celles des champs anonymes non exportés

src afficher le code source original plutôt que la documentation extraite

texte présenter la page sous forme textuelle (ligne de commande) plutôt que HTML

plat présenter des listes de répertoires plates (non indentées) en utilisant des chemins complets

Par exemple, http://golang.org/pkg/math/big/?m=all,texte affiche la documentation pour tous
(pas seulement les déclarations exportées) du package big, sous forme textuelle (comme il apparaîtrait
lors de l'utilisation de godoc depuis la ligne de commande : "godoc -src math/big .*").

Par défaut, godoc sert les fichiers du système d'exploitation sous-jacent. À la place, un fichier .zip est utilisé.
Le fichier peut être fourni via l'option -zip, qui contient le système de fichiers à servir. Le fichier
les chemins stockés dans le fichier .zip doivent utiliser une barre oblique ('/') comme séparateur de chemin ; et ils doivent être
non enraciné. $GOROOT (ou -goroot) doit être défini sur le chemin du répertoire du fichier .zip contenant le
Accédez au répertoire racine. Par exemple, pour un fichier .zip créé par la commande :

zip go.zip $HOME/go

on peut exécuter godoc comme suit :

godoc -http=:6060 -zip=go.zip -goroot=$HOME/go

Consultez « Godoc : documenter le code Go » pour savoir comment rédiger de bons commentaires pour godoc :
http://golang.org/doc/articles/godoc_documenting_go_code.html

OPTIONS

-v mode verbeux

-q les arguments sont considérés comme des requêtes de recherche : une requête légale est un identifiant unique (tel
comme ToLower) ou un identifiant qualifié (tel que math.Sin).

-src imprimer (exporter) la source en mode ligne de commande

-largeur de tabulation = 4
largeur des onglets en unités d'espaces

-timestamps=true
afficher les horodatages avec les listes de répertoires

-indice activer l'identifiant et l'index de recherche en texte intégral (aucune zone de recherche n'est affichée si -index est
(non défini)

-index_files=""
modèle glob spécifiant les fichiers d'index ; s'il n'est pas vide, l'index est lu à partir de ceux-ci
fichiers dans l'ordre trié

-index_throttle=0.75
valeur d'accélération de l'index ; une valeur de 0 signifie qu'aucun temps n'est alloué à l'indexeur (le
l'indexeur ne finira jamais), une valeur de 1.0 signifie que la création de l'index est en cours d'exécution à
plein régime (les autres goroutines peuvent ne pas avoir de temps pendant la construction de l'index)

-write_index=false
écrire l'index dans un fichier ; le nom du fichier doit être spécifié avec -index_files

-maxresults=10000
nombre maximal de résultats de recherche en texte intégral affichés (aucun index de texte intégral n'est créé si
maxresults <= 0)

-chemin=""
répertoires de packages supplémentaires (séparés par des deux-points)

-html imprimer du HTML en mode ligne de commande

-goroot=$GOROOT
Accéder au répertoire racine

-http=adresse
Adresse du service HTTP (par exemple, « 127.0.0.1:6060 » ou simplement « :6060 »)

-server=adresse
adresse du serveur Web pour les recherches en ligne de commande

-modèles=""
répertoire contenant des fichiers de modèles alternatifs ; s'il est défini, le répertoire peut fournir
fichiers modèles alternatifs pour les fichiers dans $GOROOT/lib/godoc

-url=chemin
imprimer sur la sortie standard les données qui seraient servies par une requête HTTP pour le chemin

-zip=""
fichier zip fournissant le système de fichiers à servir ; désactivé s'il est vide

Utiliser godoc en ligne avec les services onworks.net