Go 언어의 코멘트 코딩 사양은 어떻게 되나요?

주석 코딩 사양: 1. 내보낸 모든 개체에는 목적을 설명하기 위해 주석을 달아야 하며, 내보내지 않은 개체에는 상황에 따라 주석을 달아야 합니다. 2. 목적어가 셀 수 있고 수량이 명확하게 지정되지 않은 경우에는 항상 단수형을 사용하고, 그렇지 않으면 복수형을 사용합니다. 3. 패키지, 함수, 메소드, 유형에 대한 설명은 모두 완전한 문장입니다. 4. 문장형 코멘트의 첫 글자는 대문자로, 구문형 코멘트의 첫 글자는 소문자로 표기해야 합니다. 5. 코멘트는 한 줄의 길이가 80자를 초과할 수 없습니다.

이 튜토리얼의 운영 환경: Windows 7 시스템, GO 버전 1.18, Dell G3 컴퓨터.

댓글의 의미

• 댓글은 문서 작업을 잘 완료하는 데 도움이 되고, 잘 작성된 댓글은 향후 유지 관리에 도움이 됩니다.

• /**/의 블록 주석과 //의 한 줄 주석은 스타일을 통일하기 위해 모두 단일 주석 스타일입니다. 라인 주석은 우리 프로젝트에서 사용됩니다. 주석의 품질은 생성된 문서의 품질을 결정합니다. /**/ 的块注释和 // 的单行注释两种注释风格， 在我们的项目中为了风格的统一，全部使用单行注释，注释的质量决定了生成的文档的质量。

注释规范

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

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

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

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

• 注释的单行长度不能超过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:

주석 사양

내보낸 모든 개체에는 목적을 설명하기 위해 주석이 추가되어야 하며, 내보내지 않은 개체에는 상황에 따라 주석이 추가됩니다. 🎜🎜🎜🎜 목적어가 셀 수 있고 수량이 명확하게 지정되지 않은 경우에는 항상 단수형을 사용하고, 그렇지 않으면 복수형을 사용합니다. 🎜🎜🎜🎜패키지, 함수, 메소드, 타입에 대한 설명은 모두 완전한 문장으로 되어 있습니다. 🎜🎜🎜🎜문장형 댓글의 첫 글자는 대문자로, 구문형 댓글의 첫 글자는 소문자로 작성해야 합니다. 🎜🎜🎜🎜댓글 한 줄의 길이는 80자를 초과할 수 없습니다. 🎜🎜🎜🎜🎜1. 패키지 수준 🎜🎜🎜 패키지 수준 설명은 패키지에 대한 소개이므로 동일한 패키지의 소스 파일에만 명시하면 됩니다. [관련 권장 사항: Go 동영상 튜토리얼🎜, 프로그래밍 교육🎜】🎜🎜🎜🎜각 패키지에는 패키지 주석이 있어야 하며, 패키지 절 앞에는 한 줄 주석이 있어야 합니다.🎜🎜🎜🎜 패키지 주석은 다음과 같아야 합니다. 다음 기본 정보를 포함합니다🎜🎜🎜

  // 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. 구조(인터페이스) 주석🎜🎜🎜각 사용자 정의 구조 또는 인터페이스에는 구조를 간략하게 소개하고 구조 정의에 배치되는 주석이 있어야 합니다. 형식은 다음과 같습니다. : 구조 이름, 구조 설명. 동시에, 구조의 각 멤버 변수에는 멤버 변수 뒤에 배치되는 설명이 있어야 합니다(정렬에 주의). 예는 다음과 같습니다: 🎜rrreee🎜🎜3. 함수(메서드) 주석 🎜🎜🎜🎜 🎜각 함수 또는 메소드(구조 또는 인터페이스 아래의 함수를 메소드라고 함)에는 주석이 있어야 합니다. 🎜🎜🎜🎜 함수에 대한 주석에는 세 가지 측면이 포함되어야 합니다. 🎜🎜🎜rrreee🎜🎜4. 코드 논리 주석 🎜🎜🎜🎜🎜각 코드 블록 한 줄 댓글 추가 필수🎜🎜🎜🎜 TODO 사용법을 지켜보세요. 자세한 내용은 다음과 같습니다🎜🎜🎜rrreee🎜🎜기타 지침🎜🎜🎜🎜🎜특정 부분이 완료되기를 기다리는 경우 다음으로 시작하는 댓글을 사용할 수 있습니다. TODO: 유지 관리 담당자에게 알립니다. 🎜🎜🎜🎜특정 부분에 수정 또는 개선이 필요한 알려진 문제가 있는 경우 FIXME:로 시작하는 주석을 사용하여 관리자에게 알릴 수 있습니다. 🎜🎜🎜🎜문제를 구체적으로 설명해야 하는 경우 참고:로 시작하는 주석을 사용할 수 있습니다. 🎜🎜🎜rrreee🎜더 많은 프로그래밍 관련 지식을 보려면 다음을 방문하세요. 🎜프로그래밍 소개🎜 ! ! 🎜

위 내용은 Go 언어의 코멘트 코딩 사양은 어떻게 되나요?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!