Go言語でアノテーションを付ける方法

Go 言語のコメント方法: 1. 単一行の go ステートメントの前に「//」記号を配置して単一行コメントを実装します。 2. コメントアウトする必要がある部分を「/」で囲みます。 *...*/" 記号 複数行のコメントを実装するための Go コード スニペット。

この記事の環境: Windows 7 システム、Go1.11.2 バージョン、この記事はすべてのブランドのコンピューターに適用されます。

推奨: "go 言語チュートリアル"

プログラム内のコメントの役割は、プログラムを読みやすくするためにプログラムに注釈を付けて説明することです。ソースコード。 。ソースコードをコンパイルする際、コンパイルシステムはコメント部分を自動的に無視するため、コメントはプログラムの機能を実現する上で何の役割も果たしません。ソースコードにコメントを適切に追加すると、ソースコードの可読性が向上します。

Go 言語のコメントは、主に 1 行コメントと複数行コメントの 2 つのカテゴリに分類されます。

単一行コメントは行コメントと呼ばれ、最も一般的なコメント形式です。// で始まる単一行コメントはどこでも使用できます。

複数のコメント行コメントは、/ で始まるブロック コメントと呼ばれます * で始まり、*/ で終わります。ネストすることはできません。複数行のコメントは通常、パッケージのドキュメントの説明や、ブロックにコメント化されたコード スニペットに使用されます。

単一行コメントの形式は次のとおりです

//单行注释

複数行コメントの形式は次のとおりです

/*
第一行注释
第二行注释
...
*/

各パッケージには関連するコメントが必要です。パッケージを宣言する package ステートメント パッケージの機能と機能を簡単に説明するために、名前の前に対応するコメントを追加します。

同時に、パッケージ ステートメントの前のコメント内容は、デフォルトでこのパッケージのドキュメントとみなされます。パッケージは複数のファイルに分散できますが、コメントする必要があるのはそのうちの 1 つだけです。

以下に示すように、空白行を使用して複数のコメントを区切ることができます:

// Package superman implements methods for saving the world.
//
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world.
package superman

コード内の変数、定数、関数、およびその他のオブジェクトに対応するコメントを追加することをお勧めします。次のコードの enterOrbit 関数のコメントなど、後でコードをメンテナンスするのに役立ちます:

// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
   ...
}

開発者がパッケージに関する情報を知る必要がある場合、godoc を使用してパッケージのドキュメントを表示できます。

その他の関連技術記事については、golang チュートリアル 列をご覧ください。

以上がGo言語でアノテーションを付ける方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。