golang 代码注释规范

<h2 id="toc_h2_0">注释规范</h2>

包注释

<blockquote>

每个包都应该有一个包注释，一个位于 package 子句之前的块注释或行注释。包如果有多个 go 文件，只需要出现在一个 go 文件中（一般是和包同名的文件）即可。 包注释应该包含下面基本信息(请严格按照这个顺序，简介，创建人，创建时间）：

</blockquote> <pre><code>// @Title // @Description // @Author 创建人 创建时间 // @Update 创建人 修改时间</code></pre>

结构（接口）注释

 

<blockquote>

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

</blockquote>

 

<pre><code>// User ， 用户对象，定义了用户的基础信息 type User struct{ UserName string `description:"用户名称"` Email string `description:"邮箱"` } </code></pre>

函数 注释

<pre><code>// @Title 标题 // @Description 详细信息 // @Auth 创建时间 创建人 // @Param 参数类型 参数介绍 // @Return 返回类型 "错误信息"</code></pre>

 

到此这篇关于“golang 代码注释规范”的文章就介绍到这了,更多文章或继续浏览下面的相关文章，希望大家以后多多支持JQ教程网！

您可能感兴趣的文章：
golang 代码注释规范
php代码规范化编程实现
python程序注释符号是什么
Python代码的单行注释使用什么符号
JavaScript语言常量和变量
php编码规范：文档注释几种方法
php注释有哪些？
php的注释方法
php注释的作用是什么？
Python多行注释和单行注释用法详解