So erhalten Sie Kommentarinhalte in Golang

In Golang können Sie das Godoc-Tool verwenden, um Kommentarinhalte zu extrahieren. Das Godoc-Tool extrahiert die ersten Zeilenkommentare von Deklarationen der obersten Ebene und zugehörige Kommentare zu jedem Objekt aus Go-Programmen und Paketdateien und generiert zugehörige Dokumente. Es kann auch als Webserver dienen, der das Durchsuchen von Online-Dokumenten ermöglicht.

Die Betriebsumgebung dieses Tutorials: Windows 10-System, GO Version 1.18, Dell G3-Computer.

In Golang können Sie das Godoc-Tool verwenden, um Kommentarinhalte zu extrahieren.

godoc-Tool

godoc-Tool extrahiert die ersten Zeilenkommentare von Deklarationen der obersten Ebene und zugehörige Kommentare zu jedem Objekt aus Go-Programm- und Paketdateien und generiert relevante Dokumente. Es kann auch als Web verwendet werden Bietet Online-Dokumentendurchsuchung Der Server, die offizielle Website der Go-Sprache (https://golang.google.cn/), ist in dieser Form implementiert.

Hinweis: Das Godoc-Tool wurde aus der Go-Sprachversion 1.13 entfernt. Sie können das Godoc-Tool über den Befehl go get erhalten. 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

  Aufgrund von Firewalls können inländische Benutzer das Godoc-Tool möglicherweise nicht über den Befehl „go get“ erhalten. Derzeit muss es jeder manuell bedienen.
Laden Sie zunächst das Paket golang.org/x/tools von GitHub (https://github.com/golang/tools.git) herunter
• Entpacken Sie dann die heruntergeladene Datei in das Verzeichnis srcgolang.orgxtools unter GOPATH. Wenn sie nicht vorhanden ist, können Sie sie manuell erstellen.

• Öffnen Sie das Verzeichnis srcgolang.orgxtoolscmdgodoc unter GOPATH Tool in diesem Verzeichnis und führen Sie den Befehl „go build“ aus, um die ausführbare Datei „godoc.exe“ zu generieren.

  🎜
• 🎜Verschieben Sie abschließend die generierte Datei „godoc.exe“ in das Verzeichnis „bin“ unter GOPATH. (Sie müssen das bin-Verzeichnis unter GOPATH zur Umgebungsvariablen Path hinzufügen)🎜🎜🎜

  🎜🎜Nach Abschluss der oben genannten Vorgänge können Sie das Godoc-Tool verwenden. Das Godoc-Tool hat im Allgemeinen die folgenden Verwendungszwecke : 🎜

• 🎜go doc package: Holen Sie sich die Dokumentationskommentare des Pakets, zum Beispiel go doc fmt wird mit godoc-Dokumentationskommentaren des generierten fmt-Pakets angezeigt; 🎜🎜<li>🎜<code>go doc package/subpackage: Ruft die Dokumentationskommentare des Unterpakets ab, z /list
; 🎜🎜
• 🎜go doc package function: Ruft die Dokumentationskommentare einer Funktion in einem Paket ab, zum Beispiel go doc fmt Printf zeigt die relevanten Informationen zu den Gebrauchsanweisungen von fmt.Printf () an. 🎜🎜🎜🎜 Das Godoc-Tool kann den Anmerkungsinhalt auch in ../go/src im Go-Installationsverzeichnis abrufen und diesen Anmerkungsinhalt zur Vorschau in den Webserver integrieren. Geben Sie godoc -http=:6060 in die Befehlszeile ein und öffnen Sie dann mit dem Browser http://localhost:6060. Sie können die vom lokalen Dokumentbrowserserver bereitgestellte Seite sehen. 🎜

  🎜🎜🎜🎜Verwendung von godoc🎜🎜🎜🎜🎜Im Terminal anzeigen🎜🎜🎜Geben Sie im Terminal das Verzeichnis des Pakets ein, das Sie anzeigen möchten go doc um das aktuelle Paketdokument anzuzeigen 🎜🎜 Was Sie hier sehen, ist das Dokument mit dem Paketnamen sowie allen Funktionsnamen und Variablentypnamen 🎜rrreee🎜go doc <pkg>.<func> code> Sehen Sie sich die func-Funktion unter dem pkg-Paket an. Hinweis 🎜rrreee🎜Wenn Sie den vollständigen Quellcode anzeigen möchten, <code>gehen Sie zu doc ​​-src <pkg>.<func></func></pkg>🎜rrreee🎜🎜Zeigen Sie ihn an den Browser🎜🎜🎜Verwenden Sie den Befehl godoc -http =:6060🎜🎜Öffnen Sie dann den Browser und geben Sie localhost:6060/pkg oder 127.0.0.1:6060 ein /pkg in der URL, um Informationen zu allen Ihren lokalen Paketen anzuzeigen🎜🎜Wenn Sie Ihren spezifischen Paketnamen finden möchten, localhost:6060/pkg// code> oder 127.0.0.1 :6060/pkg//<packagename></packagename>🎜

  • 🎜 <path></path>Ja Der Pfad zum Paket unter Ihrem /src🎜🎜
  • 🎜<packagename></packagename> ist der Paketname🎜🎜🎜🎜🎜Exportieren Sie das Godoc-Dokument als HTML 🎜🎜🎜Verwenden Sie den Befehl godoc -url " http://localhost:6060/pkg/<pkg>/<packagename>/" > <packagename>.html</packagename></packagename></pkg>🎜
    🎜<pkg></pkg> ist der Ordner, in dem sich Ihr Paket befindet🎜🎜
    • 🎜<packagename> code> ist der exportierte Name Ihres Pakets 🎜🎜🎜🎜 Es handelt sich um eine reine HTML-Datei ohne Stylesheet, aber sie kann exportiert werden, aber ich habe sie bisher nicht gefunden. Wenn Sie Freunde haben, die sie gefunden haben, können Sie dies tun Teile es mit mir🎜🎜Aber ich habe auch die entsprechende Stildatei exportiert🎜🎜Download-Adresse https: //github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile🎜<p>Dann ändern Sie einfach die durch CSS und JS angegebenen Pfade in der HTML-Datei</p><p>[Verwandte Empfehlungen: <a href="http://www.php.cn/course/list/44.html" target="_blank">Go-Video-Tutorial</a>, <a href="https://www.php.cn/course.html" target="_blank" textvalue="编程教学">Programmierunterricht</a>]</p></packagename>

Das obige ist der detaillierte Inhalt vonSo erhalten Sie Kommentarinhalte in Golang. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!