Was ist die Kommentarcodierungsspezifikation der Go-Sprache?

Anmerkungscodierungsspezifikationen: 1. Alle exportierten Objekte müssen mit Anmerkungen versehen werden, um ihren Zweck zu erläutern. Nicht exportierte Objekte müssen entsprechend der Situation mit Anmerkungen versehen werden. 2. Wenn das Objekt zählbar ist und die Menge nicht eindeutig angegeben ist, verwenden Sie immer die Singularform und die kontinuierliche Zeitform, andernfalls verwenden Sie die Pluralform. 3. Die Kommentare zu Paketen, Funktionen, Methoden und Typen stehen alle in einem vollständigen Satz. 4. Die ersten Buchstaben von satzartigen Kommentaren müssen großgeschrieben werden; die ersten Buchstaben von Phrasenkommentaren müssen kleingeschrieben werden. 5. Die Länge einer einzelnen Kommentarzeile darf 80 Zeichen nicht überschreiten.

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

Die Bedeutung von Kommentaren

• Kommentare können uns helfen, die Dokumentarbeit gut abzuschließen, und gut geschriebene Kommentare können unsere zukünftige Wartung erleichtern.

• Der Blockkommentar von /**/ und der einzeilige Kommentar von // sind zwei Kommentarstile. In unserem Projekt werden Zeilenkommentare verwendet. Die Qualität der Anmerkungen bestimmt die Qualität der generierten Dokumente. /**/ 的块注释和 // 的单行注释两种注释风格， 在我们的项目中为了风格的统一，全部使用单行注释，注释的质量决定了生成的文档的质量。

注释规范

• 所有导出对象都需要注释说明其用途；非导出对象根据情况进行注释。

• 如果对象可数且无明确指定数量的情况下，一律使用单数形式和一般进行时描述；否则使用复数形式。

• 包、函数、方法和类型的注释说明都是一个完整的句子。

• 句子类型的注释首字母均需大写；短语类型的注释首字母需小写。

• 注释的单行长度不能超过80个字符。

1、包级别

包级别的注释就是对包的介绍，只需在同个包的任一源文件中说明即可有效。【相关推荐：Go视频教程、编程教学】

• 每个包都应该有一个包注释，一个位于 package 子句之前行注释

• 包注释应该包含下面基本信息

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

2、结构（接口）注释

每个自定义的结构体或者接口都应该有注释说明，该注释对结构进行简要介绍，放在结构体定义的前一行，格式为： 结构体名， 结构体说明。同时结构体内的每个成员变量都要有说明，该说明放在成员变量的后面（注意对齐），实例如下：

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

3、函数（方法）注释

• 每个函数，或者方法（结构体或者接口下的函数称为方法）都应该有注释说明

• 函数的注释应该包括三个方面

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

4、代码逻辑注释

• 每个代码块都要添加单行注释

• 注视使用 TODO 开始 详细如下

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

}

其它说明

• 当某个部分等待完成时，可用 TODO: 开头的注释来提醒维护人员。

• 当某个部分存在已知问题进行需要修复或改进时，可用 FIXME: 开头的注释来提醒维护人员。

• 当需要特别说明某个问题时，可用 NOTE:

Anmerkungsspezifikationen

Alle exportierten Objekte müssen mit Anmerkungen versehen werden, um ihren Zweck zu erläutern. Nicht exportierte Objekte werden entsprechend der Situation mit Anmerkungen versehen. 🎜🎜🎜🎜Wenn das Objekt zählbar ist und die Menge nicht klar angegeben ist, verwenden Sie immer die Singularform und die kontinuierliche Zeitform, andernfalls verwenden Sie die Pluralform. 🎜🎜🎜🎜Die Kommentare für Pakete, Funktionen, Methoden und Typen stehen alle in einem vollständigen Satz. 🎜🎜🎜🎜Der erste Buchstabe von Kommentaren vom Typ Satz muss groß geschrieben werden; der erste Buchstabe von Kommentaren vom Typ Phrase muss kleingeschrieben sein. 🎜🎜🎜🎜Die Länge einer einzelnen Kommentarzeile darf 80 Zeichen nicht überschreiten. 🎜🎜🎜🎜🎜1. Kommentare auf Paketebene 🎜🎜🎜 Kommentare auf Paketebene sind eine Einführung in das Paket. Sie müssen nur in einer Quelldatei desselben Pakets angegeben werden, um wirksam zu sein. [Verwandte Empfehlungen: Go-Video-Tutorial🎜, Programmierunterricht🎜】🎜🎜🎜🎜Jedes Paket sollte einen Paketkommentar und einen Zeilenkommentar vor der Paketklausel haben.🎜🎜🎜🎜 Paket Die Anmerkung sollte enthalten die folgenden grundlegenden Informationen🎜🎜🎜

  // 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)

🎜🎜2. Struktur-(Schnittstellen-)Anmerkung🎜🎜🎜Die Anmerkung sollte die Struktur kurz vorstellen und in die vorherige Zeile eingefügt werden. Das Format ist: Strukturname, Strukturbeschreibung. Gleichzeitig muss jede Mitgliedsvariable in der Struktur eine Beschreibung haben, die nach der Mitgliedsvariablen platziert wird (achten Sie auf die Ausrichtung). Beispiele sind wie folgt: 🎜rrreee🎜🎜3 Funktions- (Methoden-) Kommentare 🎜🎜🎜🎜 🎜Jede Funktion oder Methode (Funktionen unter Strukturen oder Schnittstellen werden als Methoden bezeichnet) sollte Kommentare haben. 🎜🎜🎜🎜 Kommentare zu Funktionen sollten drei Aspekte enthalten. 🎜🎜🎜rrreee🎜🎜4. Kommentare zur Codelogik Sie müssen einen einzeiligen Kommentar hinzufügen🎜🎜🎜🎜 Sehen Sie sich die Verwendung von TODO an. Die Details sind wie folgt: TODO: Wartungspersonal benachrichtigen. 🎜🎜🎜🎜Wenn bei einem bestimmten Teil ein bekanntes Problem auftritt, das behoben oder verbessert werden muss, können Sie einen Kommentar verwenden, der mit FIXME: beginnt, um den Betreuer zu benachrichtigen. 🎜🎜🎜🎜Wenn Sie ein Problem konkret erläutern müssen, können Sie einen Kommentar verwenden, der mit HINWEIS: beginnt: 🎜🎜🎜rrreee🎜Weitere programmierbezogene Kenntnisse finden Sie unter: 🎜Einführung in die Programmierung🎜 ! ! 🎜

Das obige ist der detaillierte Inhalt vonWas ist die Kommentarcodierungsspezifikation der Go-Sprache?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!