How to get comment content in golang

In golang, you can use the godoc tool to extract comment content. The godoc tool extracts the first line comments of top-level declarations and related comments of each object from Go programs and package files, and generates related documents. It can also serve as a web server that provides online document browsing.

The operating environment of this tutorial: Windows 10 system, GO version 1.18, Dell G3 computer.

In golang, you can use the godoc tool to extract comment content.

godoc tool

The godoc tool extracts the first line comments of top-level declarations and related comments for each object from Go program and package files. , and generate relevant documents, and can also be used as a web server that provides online document browsing. The Go language official website (https://golang.google.cn/) is implemented in this form.

Note: The godoc tool has been removed from Go language version 1.13. You can obtain the godoc tool through the go get command.

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

Due to firewalls, domestic users may not be able to obtain the godoc tool through the go get command. At this time, everyone needs to operate it manually.

• First download the golang.org/x/tools package from GitHub (https://github.com/golang/tools.git);

• Then unzip the downloaded file into the src\golang.org\x\tools directory under GOPATH. If not, you can create it manually;

• Open src\golang under GOPATH .org\x\tools\cmd\godoc directory, open the command line tool in this directory, and execute the go build command to generate the godoc.exe executable file;

• Finally, The generated godoc.exe file is moved to the bin directory under GOPATH. (You need to add the bin directory under GOPATH to the environment variable Path)

After completing the above operations, you can use the godoc tool. The godoc tool is generally There are several usages:

• go doc package: Get the documentation comments of the package, for example go doc fmt will display the documentation generated using godoc Documentation comments of the fmt package;

• go doc package/subpackage: Get the documentation comments of the subpackage, such as go doc container/list;

• go doc package function: Get the documentation comments of a function in a package, for example go doc fmt Printf will display the relevant fmt.Printf() Instructions for use.

The godoc tool can also obtain the comment content in ../go/src in the Go installation directory, and integrate these comment contents into the web server for us to preview. Enter godoc -http=:6060 on the command line, and then use a browser to open http://localhost:6060. You can see the page provided by the local document browsing server.

Use of godoc

##View in terminal

In the terminal, enter the directory of the package you want to view

go docDisplay the document of the current package

What you view here is the document of the package name, as well as all function names and variable type names

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 .View the comments of the func function under the pkg package

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

If you want to view the complete source code

go doc - src .

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
    }

View on browser

Use command

godoc -http=:6060

Then open the browser and enter

localhost:6060/pkg or 127.0.0.1:6060/pkg in the url to view all your local files Package information

If you want to find your specific package name

localhost:6060/pkg//or127.0.0.1: 6060/pkg//

• ##

  is the path to the package under your /src

• is the package name

Export godoc document as HTML

Use command

godoc -url "http://localhost:6060/pkg///" > .html

• is the folder where your package is located

• is your package name

The exported file is a pure html file without a style sheet. However, it may be possible to export it, but I haven’t found it yet. If you have friends who have found it, you can also share it

But I also exported the corresponding style file

Download address https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile

Then just modify the path specified by the css and js in the html file

[Related recommendations: Go video tutorial, Programming teaching】

The above is the detailed content of How to get comment content in golang. For more information, please follow other related articles on the PHP Chinese website!