Comment puis-je afficher la documentation de mon package Go localement dans un navigateur à l'aide de « godoc » ?

Affichage local de la documentation des packages dans un navigateur

Lors du développement de packages, il peut être utile de prévisualiser leur documentation localement avant de les publier. Bien que la commande godoc puisse générer une documentation texte, elle propose également un mode serveur HTTP pour afficher la documentation dans un navigateur. Cependant, vous pourriez rencontrer des difficultés pour le faire fonctionner correctement.

Si vous rencontrez un problème où godoc -http=:6060 n'affiche pas la documentation de votre propre paquet mais affiche à la place la page d'accueil Go, assurez-vous que le Le package se trouve dans le bon chemin. Par défaut, godoc recherche les packages dans l'arborescence des sources de GOPATH ou du module. Si votre package se trouve en dehors de ces répertoires, il ne sera pas trouvé.

En mode GOPATH :

Lorsque vous travaillez en mode GOPATH, godoc -http servira de documentation pour tous les packages disponibles, y compris la bibliothèque standard. Pour afficher la documentation de votre package, accédez simplement à http://localhost:6060/pkg/your/package.

En mode Module-Aware :

En module- mode conscient, godoc n'est pas compatible avec le GOPATH. Par conséquent, pour afficher la documentation de vos modules localement, vous devrez placer leur code source dans un dossier src. Par exemple, si votre module se trouve dans le répertoire /home/user/mymodule, créez un nouveau répertoire appelé src à l'intérieur et déplacez-y les fichiers sources du module.

Une fois les fichiers sources dans le dossier src, démarrez godoc en utilisant la commande suivante :

godoc -goroot=/home/user/mymodule -http=:6060

Cela devrait vous permettre de consulter la documentation de votre package sur http://localhost:6060/pkg/mymodule.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!