Golang 注释规范

注释的意义#

注释可以帮我们很好的完成文档的工作，写得好的注释可以方便我们以后的维护。
/**/ 的块注释和 // 的单行注释两种注释风格，在我们的项目中为了风格的统一，全部使用单行注释，注释的质量决定了生成的文档的质量。
下面从包注释、结构体（接口）注释、函数（方法）注释、代码逻辑注释以及注释规范方面进行说明。

包注释#

每个包都应该有一个包注释，一个位于 package 子句之前行注释
包注释应该包含下面基本信息

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

结构（接口）注释#

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

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

函数（方法）注释#

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

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

代码逻辑注释#

每个代码块都要添加单行注释
注视使用 TODO 开始详细如下

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

注释要求#

统一使用中文注释，对于中英文字符之间严格使用空格分隔，这个不仅仅是中文和英文之间，英文和中文标点之间也都要使用空格分隔
全部使用单行注释，禁止使用多行注释
和代码的规范一样，单行注释不要过长，禁止超过 120 字符。

缩进和折行#

缩进必须使用 gofmt 工具格式化
折行方面，一行最长不超过 120 个字符，超过的请使用换行展示，尽量保持格式优雅

括号和空格#

括号和空格方面，也可以直接使用 gofmt 工具格式化（go 会强制左大括号不换行，换行会报语法错误），所有的运算符和操作数之间要留空格。

import 规范#

// 单行引入
import  "fmt"// 多包引入，每包独占一行
// 使用绝对路径，避免相对路径如 ../encoding/json
import ("strings""fmt"
)

Golang 注释规范相关推荐

golang 注释规范
注释的意义注释可以帮我们很好的完成文档的工作,写得好的注释可以方便我们以后的维护. /**/ 的块注释和 // 的单行注释两种注释风格, 在我们的项目中为了风格的统一,全部使用单行注释,注释的质量决 ...
goland 方法注释_godoc 介绍以及 Golang 注释规范
这边是字节电商交易中心中台团队,最近业务在快速发展,技术上也很有挑战,既然你读到了这里,我也觉得你很合适,何不考虑来试一试? 命令 golang 官方有有文档自动生成网站,地址是 godoc.org, ...
golang 代码注释规范
注释规范包注释每个包都应该有一个包注释,一个位于 package 子句之前的块注释或行注释.包如果有多个 go 文件,只需要出现在一个 go 文件中(一般是和包同名的文件)即可. 包注释应该包含下 ...
c++ doxygen 注释规范_[代码规范]Go语言编码规范指导
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...
函数注释规范_Go语言编码规范
本规范旨在为日常Go项目开发提供一个代码的规范指导,方便团队形成一个统一的代码风格,提高代码的可读性,规范性和统一性.本规范将从命名规范,注释规范,代码风格和 Go 语言提供的常用的工具这几个方面做一 ...
golang注释和文档说明及go doc/godoc说明
欢迎关注个人公众号 DailyJobOps 这里提前祝大家 2022新年快乐~ 原文连接 golang注释和文档说明及go doc/godoc说明 golang注释单行注释是最常见和使用的注释方式 ...
doxygen 注释规范_编程规范 - doxygen注释规范示例（C++）
doxygen注释规范示例(C++) doxygen能根据code的注释自动生成code的帮助文档,并且doxygen是一个跨平台的开源的软件,但是要生成帮助文档,code内的注释必须按一定规则书写. ...
使用VA助手如何快速添加注释(按doxygen注释规范)
原文首发于微信公众号「3D视觉工坊」:使用VA助手如何快速添加注释(按doxygen注释规范) 首先,关于VA助手的破解安装教程,请参考:VS2015 Visual Assist X 破解版安装教程 ...
PHP中类和文件的代码注释规范
编写好的文档对于任何软件项目都至关重要,不仅是因为文档的质量可能比代码的质量更重要,还因为良好的第一印象会促使开发人员进一步查看代码以及后续的迭代. 文件注释 /*** Sample file com ...

Golang 注释规范

注释的意义#

包注释#

结构（接口）注释#

函数（方法）注释#

代码逻辑注释#

注释要求#

缩进和折行#

括号和空格#

import 规范#

Golang 注释规范相关推荐

最新文章

热门文章