go言語のコメントコーディング仕様とは何ですか？

コメントエンコーディングの仕様: 1. エクスポートされたすべてのオブジェクトにはその目的を説明するコメントが必要であり、エクスポートされていないオブジェクトには状況に応じてコメントが必要です。 2. 対象が可算であり、数量が明確に指定されていない場合は、常に単数形と継続継続時制を使用し、それ以外の場合は複数形を使用します。 3. パッケージ、関数、メソッド、型のコメントはすべて完全な文になっています。 4. 文タイプのコメントの最初の文字は大文字にする必要があり、フレーズタイプのコメントの最初の文字は小文字にする必要があります。 5. コメントの 1 行の長さは 80 文字を超えることはできません。

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

コメントの意味

• コメントは、ドキュメントの作業を適切に完了するのに役立ちます。適切に書かれたコメントは、将来のメンテナンスを容易にします。コメント スタイルには、

• /**/ のブロック コメントと // の単一行コメントの 2 つがあります。スタイルを統一するために、すべての単一行コメントが使用され、コメントの品質によって生成されるドキュメントの品質が決まります。

コメント仕様

• エクスポートされたすべてのオブジェクトには、その目的を説明するコメントが必要です。エクスポートされていないオブジェクトは、状況に応じてコメントされます。

• オブジェクトが可算で、数量が明示的に指定されていない場合は、常に単数形と連続時制の記述を使用します。それ以外の場合は、複数形を使用します。

• パッケージ、関数、メソッド、型のコメントはすべて完全な文です。

• 文タイプのコメントの最初の文字は大文字にする必要があり、フレーズタイプのコメントの最初の文字は小文字にする必要があります。

• コメントの 1 行の長さは 80 文字を超えることはできません。

1. パッケージ レベル

パッケージ レベルのコメントはパッケージの紹介であり、パッケージのソース ファイルにのみ含める必要があります。同じパッケージです。説明は有効です。 [関連する推奨事項: Go ビデオ チュートリアル 、プログラミング教育 ]

• 各パッケージにはパッケージ コメントが必要です (パッケージ句に 1 つ)。行コメント

• パッケージ コメントには、次の基本情報

// @Title  请填写文件名称（需要改）
// @Description  请填写文件描述（需要改）
// @Author  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
// @Update  请填写自己的真是姓名（需要改）  ${DATE} ${TIME}
package ${GO_PACKAGE_NAME}

2 を含める必要があります。構造 (インターフェイス) コメント

各カスタム構造またはインターフェイスにはコメントが必要です。コメントは構造を簡単に紹介し、構造定義の前の行に配置されます。形式は、構造名、構造の説明です。同時に、構造体の各メンバー変数には説明が必要です。説明はメンバー変数の後に配置されます (位置合わせに注意してください)。例は次のとおりです:

// User   用户对象，定义了用户的基础信息
type User struct{
    Username  string // 用户名
    Email     string // 邮箱
}

3. 関数(メソッド) コメント

• 各関数またはメソッド (構造体またはインターフェースの下にある関数をメソッドと呼びます) にはコメントが必要です

• 関数のコメントには 3 つの側面が含まれている必要があります

// @title    函数名称
// @description   函数的详细描述
// @auth      作者             时间（2019/6/18   10:57 ）
// @param     输入参数名        参数类型         "解释"
// @return    返回参数名        参数类型         "解释"

4. コード ロジック コメント

• 1 行各コードブロックにコメントを追加する必要があります

• 見て、TODO を使用してください。詳細は次のとおりです。

##

// TODO  代码块的执行解释
if   userAge < 18 {

}

その他の指示

• 特定の部分が完了を待っているとき、

  TODO: で始まるコメントを使用して、メンテナに思い出させることができます。

• 特定のパーツに修正または改善が必要な既知の問題がある場合、

  FIXME: で始まるコメントを使用してメンテナに警告できます。

• 特に問題を説明する必要がある場合は、

  NOTE::

  // NOTE: os.Chmod and os.Chtimes don't recognize symbolic link,
  // which will lead "no such file or directory" error.
  return os.Symlink(target, dest)

## で始まるコメントを使用できます。 #その他のプログラミング 関連知識については、

プログラミング入門

をご覧ください。 ！

以上がgo言語のコメントコーディング仕様とは何ですか？の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。