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

php注释规范（phpdoc）总结(代码片段)

...IDE或看过其他源码的小伙伴们应该都见过类似下面这样的注释/***递归获取所有游戏分类*@paramint$id*@returnarray*/看得多了就大概知道了一些规律。为了使自己的代码更加规zhuang范bi，也开始有样学样地写着这些注释。其实这种注释... 查看详情

编码规范篇|c#编码规范代码规范总结，包括命名规范，代码规范注释规范等(代码片段)

🎬博客主页：https://xiaoy.blog.csdn.net🎥本文由呆呆敲代码的小Y原创，首发于CSDN🙉🎄学习专栏推荐：Unity精品学习专栏🌲游戏制作专栏推荐：游戏制作分享🌲Unity实战100例专栏推荐：Unity... 查看详情

doxygen注释语法规范(代码片段)

...多的是作为了解，但是可以以这样的规范作为自己的编程注释习惯，提高自己的软实力。Doxygen注释语法注释格式块注释建议统一使用/**……***/行注释建议统一使用///<…/**……*/Doxygen常用注释命令@exception<exception-object>excep... 查看详情

代码规范(代码片段)

...，不能至让自己看懂，要有一定的可阅读性，也必须要有注释，注释是不能少的例如开始先写多行注释/*确定需求：在控制台打印“hel 查看详情

数据开发的代码规范以及代码评审脚本（持续更）(代码片段)

...xff08;待完成）2.2、Python代码规范2.2.1、命名规范2.2.2、注释规范2.2.3、其它规范2.3、SQL代码规范2.4、Java和Scala代码规范3、代码评审自动化脚本1、前言在数据开发中，由于各程序员的风格不一、注释过少等原因，导致后... 查看详情

写出规范化的高可读性的函数代码注释(代码片段)

...的代码更加perfect，更加高可读性，其中各个函数的代码注释就是非常关键的一步：/***函数功能*@name名字*@abstract申明变量/类/方法*@access指明这个变量、类、函数/方法的存取权限*@author函数作者的名字和邮箱地址*@category组织package... 查看详情

golang急速入门手册(代码片段)

1/*2gotips_test.go:3Golang速学速查速用代码手册45Source:github.com/coderzh/CodeTips/blob/master/gotips_test.go67Author:coderzh(github.com/coderzh)8Blog:http://blog.coderzh.com9参考：《Go语言编程》10*/1112packagemain1314import(15"errors"16"fmt"17"github.com/stretchr/testify/assert"1... 查看详情

php走进php第三课基础语法(代码片段)

【PHP】✔️走进PHP✔️第三课基础语法概述注释代码规范字符串拼接运算符判断语句循环语句while循环dowhile循环for循环概述从今天开始,小白我将带领大家一起来学习一下PHP的基础知识.注释注释(Comment)是对代码的解释和说明.在代... 查看详情

小白学js第六天之代码规范，作用域以及预解析(代码片段)

目录代码规范命名规范变量规范注释规范空格规范换行规范作用域全局变量局部变量块级作用域作用域链预解析什么是预解析变量提升此篇木有脑图，嘻嘻代码规范命名规范变量、函数的命名必须要有意义变量一般用名词函数一... 查看详情

python文件头部规范注释与省略内容杂记(代码片段)

...指定编码，如使用#-*-coding:utf-8-*-指定此文件的编码为UTF-8注释单行注释：#。如下——#我是一个单行注释！#Python解释器会自动跳过注释而并不会执行它！多行注释：\'\'\'\'\'\'或""""""。如下——\'\'\'我是一个多行注释！Python解释器... 查看详情

数据开发的代码规范以及代码评审脚本（不定更）(代码片段)

...本1、前言在数据开发中，由于各程序员的风格不一、注释过少等原因，导致后期代码修改时困难重重代码评审：通过阅读代码来检查代码质量代码评审有助于降低后期代码维护成本使用代码评审自动化脚本（Python... 查看详情

（转）golang使用iota(代码片段)

iota是什么我们来看golang源码的注释里面是怎么说的iotaisapredeclaredidentifierrepresentingtheuntypedintegerordinalnumberofthecurrentconstspecificationina(usuallyparenthesized)constdeclaration.Itiszero-indexed.大概就可以理解为 查看详情

（转）golang使用iota(代码片段)

iota是什么我们来看golang源码的注释里面是怎么说的iotaisapredeclaredidentifierrepresentingtheuntypedintegerordinalnumberofthecurrentconstspecificationina(usuallyparenthesized)constdeclaration.Itiszero-indexed.大概就可以理解为 查看详情

vue实战vue开发中的的前端代码风格规范(代码片段)

...的表达式2.1.9带引号的attribute值2.1.10指令缩写🌟三、注释规范3.1HTML文件注释3.1.1单行注释3.1.2模块注释3.1.3嵌套模块注释3.2CSS文件注释3.2.1单行注释3.2.2模块注释3.2.3文件注释3.3JavaScript文件注释3.3.1单行注释3.3.2多行注释3.3.3注... 查看详情

golang注释

注释可提高代码可读性编译器编译时自动忽略注释段内容单行注释//单行注释块注释/*块注释*/ 查看详情

c语言编码“注释”规范(代码片段)

...的源码让你阅读，并理解重构代码，但里面一句注释都没有，我想这肯定是之前同事“删库跑路”了。看一份源码什么很重要？除了各种代码规范之外，还有一个比较重要的就是注释。注释虽然写起来很痛苦,... 查看详情

注释关键字标识符(代码片段)

添加注释comment单行注释多行注释文档注释//这是单行注释的文字/*这是多行注释的文字这是多行注释的文字这是多行注释的文字*//**这是文档注释的文字@authorAdministrator*/注释：就是对代码的解释和说明。其目的是让人们能够更加... 查看详情

golang编程思维和工程实战(代码片段)

Golang的一些编程思维和思想，以及总结一些常见的优雅编程实战技巧。作者：allendbwu，腾讯PCG后台开发工程师一Golang编程思维首先，我们先来看下最基本的，就是Golang的学习技巧，比如通读Golang的一些好的文章：FrequentlyAskedQuesti... 查看详情