godoc - En ligne dans le Cloud

PROGRAMME:

Nom

godoc - extrait et génère de la documentation pour les programmes Go

SYNOPSIS

bondoc [drapeau] commande [ prénom ]

DESCRIPTION

Godoc extrait et génère de la documentation pour les programmes Go.

Il a deux modes.

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

godoc fmt # documentation pour le paquet fmt
godoc fmt Printf # documentation pour fmt.Printf
godoc cmd/go # force la documentation de la commande go
godoc -src fmt # interface de 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 explicite n'est spécifiée avec l'indicateur -server, godoc d'abord
essaie localhost:6060 puis http://golang.org.

godoc -q Lecteur
godoc -q math.Sin
godoc -server=:6060 -q péché

Avec l'indicateur -http, il s'exécute en tant que 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 le drapeau -path qui accepte une liste de deux-points-
chemins séparés; les chemins non rootés sont relatifs au répertoire de travail actuel. Chaque chemin
est considérée comme une racine supplémentaire pour les packages par ordre d'apparition. Le dernier
L'élément path (absolu) est le préfixe du chemin du package. Par exemple, étant donné le drapeau
valeur:

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

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

/home/user/godoc/x -> godoc/x
/accueil/barre/x -> barre/x
/public/x -> public/x

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

L'index contient à la fois l'identifiant et les informations de recherche en texte intégral (recherchables via
expressions régulières). Le nombre maximum 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 en 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 montrer 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 d'origine 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 plats (non indentés) en utilisant des chemins complets

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

Par défaut, godoc sert les fichiers du système de fichiers du système d'exploitation sous-jacent. Au lieu de cela, un .zip
peut être fourni via l'indicateur -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
sans racine. $GOROOT (ou -goroot) doit être défini sur le chemin du répertoire du fichier .zip contenant le
Allez dans le répertoire racine. Par exemple, pour un fichier .zip créé par la commande :

zip aller.zip $HOME/aller

on peut exécuter godoc comme suit :

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

Voir « 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 la source (exportée) en mode ligne de commande

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

-horodatages=vrai
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
pas encore défini)

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

-index_throttle=0.75
valeur d'accélérateur d'index ; une valeur de 0 signifie qu'aucun temps n'est alloué à l'indexeur (le
l'indexeur ne se terminera jamais), une valeur de 1.0 signifie que la création de l'index s'exécute à
plein régime (les autres goroutines peuvent ne pas avoir le temps pendant que l'index est construit)

-write_index=faux
é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 en texte intégral n'est créé si
maxrésultats <= 0)

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

-html imprimer HTML en mode ligne de commande

-goroot=$GOROOT
Aller au répertoire racine

-http=adresse
Adresse de service HTTP (par exemple, '127.0.0.1:6060' ou simplement ':6060')

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

-modèles=""
répertoire contenant des fichiers 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é si vide

Utiliser godoc en ligne en utilisant les services onworks.net