注释编码规范:1、所有导出对象都需要注释说明其用途;非导出对象根据情况进行注释。2、如果对象可数且无明确指定数量的情况下,一律使用单数形式和一般进行时描述;否则使用复数形式。3、包、函数、方法和类型的注释说明都是一个完整的句子。4、句子类型的注释首字母均需大写;短语类型的注释首字母需小写。5、注释的单行长度不能超过80个字符。
php入门到就业线上直播课:进入学习
Apipost = Postman + Swagger + Mock + Jmeter 超好用的API调试工具:点击使用
本教程操作环境:windows7系统、GO 1.18版本、Dell G3电脑。
注释的意义
-
注释可以帮我们很好的完成文档的工作,写得好的注释可以方便我们以后的维护。
-
/**/
的块注释和//
的单行注释两种注释风格, 在我们的项目中为了风格的统一,全部使用单行注释,注释的质量决定了生成的文档的质量。
注释规范
-
所有导出对象都需要注释说明其用途;非导出对象根据情况进行注释。
-
如果对象可数且无明确指定数量的情况下,一律使用单数形式和一般进行时描述;否则使用复数形式。
-
包、函数、方法和类型的注释说明都是一个完整的句子。
-
句子类型的注释首字母均需大写;短语类型的注释首字母需小写。
-
注释的单行长度不能超过80个字符。
1、包级别
包级别的注释就是对包的介绍,只需在同个包的任一源文件中说明即可有效。【