Comment obtenir le contenu des commentaires dans Golang

Dans Golang, vous pouvez utiliser l'outil godoc pour extraire le contenu des commentaires. L'outil godoc extrait les commentaires de première ligne des déclarations de niveau supérieur et les commentaires associés de chaque objet des programmes Go et des fichiers de package, et génère des documents associés. Il peut également servir de serveur Web permettant la navigation dans les documents en ligne.

L'environnement d'exploitation de ce tutoriel : système Windows 10, GO version 1.18, ordinateur Dell G3.

Dans Golang, vous pouvez utiliser l'outil godoc pour extraire le contenu des commentaires.

outil godoc

L'outil godoc extraira les commentaires de première ligne des déclarations de niveau supérieur et les commentaires associés de chaque objet à partir des fichiers du programme et du package Go, et générera des documents pertinents. permet la navigation dans les documents en ligne. Le serveur du site officiel de la langue Go (https://golang.google.cn/) est implémenté sous cette forme.

Remarque : L'outil godoc a été supprimé de la version 1.13 du langage Go. Vous pouvez obtenir l'outil godoc via la commande go get. go get 命令来获取 godoc 工具。

go get golang.org/x/tools/cmd/godoc

由于防火墙的原因，国内的用户可能无法通过go get 命令来获取 godoc 工具，这时候就需要大家来手动操作了。

• 首先从 GitHub（https://github.com/golang/tools.git） 下载 golang.org/x/tools 包；

• 然后将下载得到的文件解压到 GOPATH 下的 srcgolang.orgxtools 目录中，没有的话可以手动创建；

• 打开 GOPATH 下的 srcgolang.orgxtoolscmdgodoc 目录，在该目录下打开命令行工具，并执行go build 命令，生成 godoc.exe 可执行文件；

• 最后，将生成的 godoc.exe 文件移动到 GOPATH 下的 bin 目录中。（需要把 GOPATH 下的 bin 目录添加到环境变量 Path 中）

完成上述操作后就可以使用 godoc 工具了，godoc 工具一般有以下几种用法：

• go doc package：获取包的文档注释，例如go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释；

• go doc package/subpackage：获取子包的文档注释，例如go doc container/list；

• go doc package function：获取某个函数在某个包中的文档注释，例如go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。

godoc 工具还可以获取 Go 安装目录下 ../go/src 中的注释内容，并将这些注释内容整合到 web 服务器中供我们预览。在命令行输入godoc -http=:6060，然后使用浏览器打开 http://localhost:6060 后，就可以看到本地文档浏览服务器提供的页面。

godoc的使用

在终端查看

在终端，进入要查看的包的目录go doc显示当前包的文档

这里查看的是包名的文档，以及所有的函数名字跟变量类型名

example:
    go doc
    
terminal show:
    package test // import "test/testdoc"
    这个是a.go的包名的描述


    At 20191017 by Baiyu
    
    ---a.go end---
    
    这个是在doc.go 文件中的内容
    
    在Go的源代码中
    
    在Mac系统中
    
    在类Unix系统中
    
    在Windows系统中
    
    ---doc.go end---
    
    这个是在testgodoc.go文件的内容 package Name: test
    
        describe:    程序的入口
    
    ---testgodoc.go end---
    
    这个是z.go 的包名描述
    
    ---z.go end---
    
    const Email ...
    const Baiyu = "baiyu"
    func H(h1 string, h2 string) (reValue string)
    func Test(param1 string, inter int) (k string)
    func Z()
    type Computer struct{ ... }
    type Person struct{ ... }
    
    BUG: 这个注释会生成在文档最后后面，同时因为紧跟着fun Z，所以在上面的func列表里面也有显示
    功能: 生成Z签名
    
    BUG: 因为前面有BUG(who)这个关键字，所以这句注释就算没有紧跟关键字不会被隐藏掉
    
    BUG: BUG(6):格式正确，所以这句注释就算没有紧跟关键字不会被隐藏掉，前面的BUG():、BUG6:、BUG:都是不正确的BUG(who)命名

go doc <pkg>.<func></func></pkg>查看pkg包下面的func函数的注释

example:
    go doc test.Test
    
terminal show:
     package test // import "test/testdoc"
     func Test(param1 string, inter int) (k string)
        功能: 测试函数
   
        参  数:
            param1  : 说明参数值
            inter   : 运算的数字
        返回值:
            k       : 返回值

如果想查看完整的源码go doc -src <pkg>.<func></func></pkg>

example: 
    go doc -src test.Test 
    
terminal show:
    package test // import "test/testdoc"
    // 功能: 测试函数
    //  参  数:
    //      param1  : 说明参数值
    //      inter   : 运算的数字
    //  返回值:
    //      k       : 返回值
    func Test(param1 string, inter int) (k string) {
            fmt.Println("测试函数")
            return param1
    }

在浏览器上查看

使用命令godoc -http=:6060

然后在打开浏览器的，在url输入localhost:6060/pkg或者127.0.0.1:6060/pkg就可以查看到你本地的所有包的信息了

如果你想要找到你特定的包名的话localhost:6060/pkg/<path>/<packagename></packagename></path>或者127.0.0.1:6060/pkg/<path>/<packagename></packagename></path>

• <path></path>是你/src下包所在的路径

• <packagename></packagename>是包名

导出godoc文档为HTML

使用命令godoc -url "http://localhost:6060/pkg/<pkg>/<packagename>/" > <packagename>.html</packagename></packagename></pkg>

• <pkg></pkg>是你包所在的文件夹

• <packagename></packagename>rrreee

  En raison des pare-feu, les utilisateurs nationaux peuvent ne pas pouvoir obtenir l'outil godoc via la commande go get. Pour le moment, tout le monde doit l'utiliser manuellement.
Téléchargez d'abord le package golang.org/x/tools depuis GitHub (https://github.com/golang/tools.git

) ;

• Décompressez ensuite le fichier téléchargé dans le répertoire srcgolang.orgxtools sous GOPATH. S'il n'existe pas, vous pouvez le créer manuellement

• Ouvrez le répertoire srcgolang.orgxtoolscmdgodoc sous GOPATH et ouvrez la ligne de commande ; outil dans ce répertoire et exécutez la commande go build pour générer le fichier exécutable godoc.exe 🎜🎜
• 🎜Enfin, déplacez le fichier godoc.exe généré vers le répertoire bin sous GOPATH. (Vous devez ajouter le répertoire bin sous GOPATH à la variable d'environnement Path)🎜🎜🎜

  🎜🎜Après avoir effectué les opérations ci-dessus, vous pouvez utiliser l'outil godoc. L'outil godoc a généralement les utilisations suivantes : 🎜

• 🎜go doc package : obtenez les commentaires de documentation du package, par exemple, go doc fmt affichera à l'aide de godoc les commentaires de documentation du package fmt généré ; 🎜🎜<li>🎜<code>go doc package/subpackage : obtenez les commentaires de documentation du sous-paquet, tels que go doc containers /list; 🎜🎜
• 🎜go doc package function : récupère les commentaires de documentation d'une fonction dans un package, par exemple, go doc fmt Printf affichera les informations pertinentes sur les instructions d'utilisation de fmt.Printf (). 🎜🎜🎜🎜 L'outil godoc peut également obtenir le contenu des annotations dans ../go/src dans le répertoire d'installation de Go, et intégrer ce contenu d'annotation dans le serveur Web pour que nous puissions le prévisualiser. Entrez godoc -http=:6060 sur la ligne de commande, puis utilisez le navigateur pour ouvrir http://localhost:6060. Vous pouvez voir la page fournie par le serveur de navigation de documents local. 🎜

  🎜🎜🎜🎜Utilisation de godoc🎜🎜🎜🎜🎜Afficher dans le terminal🎜🎜🎜Dans le terminal, entrez le répertoire du package que vous souhaitez visualiser go doc pour afficher le document du package actuel 🎜🎜 Ce que vous voyez ici est le document du nom du package, ainsi que tous les noms de fonctions et de types de variables 🎜rrreee🎜go doc <pkg>.<func> code> Affichez la fonction func sous le package pkg Remarque 🎜rrreee🎜Si vous souhaitez afficher le code source complet <code>, allez doc -src <pkg>.<func></func></pkg>🎜rrreee🎜🎜Affichez-le sur le navigateur🎜🎜🎜Utilisez la commande godoc -http =:6060🎜🎜Puis ouvrez le navigateur et saisissez localhost:6060/pkg ou 127.0.0.1:6060 /pkg dans l'URL pour l'afficher Informations sur tous vos packages locaux🎜🎜Si vous souhaitez trouver le nom de votre package spécifique, localhost:6060/pkg// code> ou 127.0.0.1 :6060/pkg//<packagename></packagename>🎜

  • 🎜 <path></path>Oui Le chemin d'accès au package sous votre /src🎜🎜
  • 🎜<packagename></packagename> est le nom du package🎜🎜🎜🎜🎜Exportez le document godoc au format HTML 🎜🎜🎜Utilisez la commande godoc -url " http://localhost:6060/pkg/<pkg>/<packagename>/" <packagename>.html</packagename></packagename></pkg>🎜
    🎜<pkg></pkg> est le dossier dans lequel se trouve votre package🎜🎜
    • 🎜<packagename> code> est le nom exporté de votre package🎜🎜🎜🎜 C'est un fichier HTML pur sans feuille de style, mais il peut être exporté, mais je ne l'ai pas trouvé jusqu'à présent. Si vous avez des amis qui l'ont trouvé, vous pouvez. partagez-le avec moi🎜🎜Mais j'ai également exporté le fichier de style correspondant🎜🎜Adresse de téléchargement https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile🎜<p>Ensuite, modifiez simplement les chemins spécifiés par css et js dans le fichier html</p><p>[Recommandations associées : <a href="http://www.php.cn/course/list/44.html" target="_blank">Tutoriel vidéo Go</a>, <a href="https://www.php.cn/course.html" target="_blank" textvalue="编程教学">Enseignement de la programmation</a>]</p></packagename>

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!