golangでコメント内容を取得する方法

golang では、godoc ツールを使用してコメントの内容を抽出できます。 godoc ツールは、Go プログラムやパッケージ ファイルからトップレベルの宣言の 1 行目のコメントや各オブジェクトの関連コメントを抽出して関連ドキュメントを生成し、オンラインでドキュメントを閲覧できる Web サーバーとしても機能します。

このチュートリアルの動作環境: Windows 10 システム、GO バージョン 1.18、Dell G3 コンピューター。

golang では、godoc ツールを使用してコメントの内容を抽出できます。

godoc ツール

godoc ツールは、Go プログラムとパッケージからトップレベルの宣言の最初の行のコメントと各オブジェクトの関連コメントを抽出します。ファイルを作成したり、関連ドキュメントを生成したり、オンラインでドキュメントを閲覧できる Web サーバーとしても使用できます。Go 言語の公式 Web サイト (https://golang.google.cn/) はこの形式で実装されています。

注: godoc ツールは Go 言語バージョン 1.13 から削除されました。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 の下の src\golang.org\x\tools ディレクトリに解凍します。そうでない場合は、手動で作成できます。

• GOPATH の下にある src\golang を開きます.org\x\tools\cmd\godoc ディレクトリに移動し、このディレクトリでコマンド ライン ツールを開き、go build コマンドを実行して godoc.exe 実行可能ファイルを生成します。

• 最後に、生成された godoc.exe ファイルは、GOPATH 下の bin ディレクトリに移動されます。 (環境変数 Path に GOPATH 配下の bin ディレクトリを追加する必要があります。)

上記の操作が完了すると、godoc ツールが使用できるようになります。 godoc ツールは通常、いくつかの使用法があります:

go doc package
• : パッケージのドキュメント コメントを取得します (例:

  go doc fmt##)。 # godoc を使用して生成されたドキュメントが表示されます fmt パッケージのドキュメント コメント;

  go doc package/subpackage
: # などのサブパッケージのドキュメント コメントを取得します。 ##go doccontainer/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 関数のコメントを表示します

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

If完全なソース コードを表示したい場合は、

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
    }

ブラウザで表示

使用commandgodoc -http=:6060

次にブラウザを開いて、localhost:6060/pkg

または

127.0.0.1:6060/pkg と入力します。すべてのローカル ファイルを表示するには、URL に入力します。 パッケージ情報

特定のパッケージ名を見つけたい場合は、

localhost:6060/pkg//または127.0.0.1: 6060/pkg//

# は、次のパッケージへのパスです。 /src

• はパッケージ名です

• godoc ドキュメントを HTML としてエクスポート

  コマンドを使用します
godoc -url "http://localhost:6060/pkg///" > .html

は、パッケージが配置されているフォルダーです。

• はパッケージ名です

• エクスポートされたファイルは、スタイル シートのない純粋な HTML ファイルです。ただし、エクスポートできる可能性がありますが、まだ見つかりません。それを見つけた友達がいる場合は、共有することもできます

  ただし、対応するスタイル ファイルもエクスポートしました

  ダウンロード アドレス https://github.com/BaiYu96/golandLearn/tree/master/ learn_doc/stylefile

次に、HTML ファイル内の css と js で指定されたパスを変更するだけです。

[関連する推奨事項: Go ビデオ チュートリアル 、プログラミング教育 ]

以上がgolangでコメント内容を取得する方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。