一 背景
为了统一规范,决定在项目中要增加注释,包括文件的头部注释以及函数方法的注释。函数方法的注释好说,文件头部注释这个搞了半天(搞完后才发现真的很容易),记录下自己搞得过程,方便其他人。
二 设置头部注释的步骤
我的系统环境是Macos,这篇文章针对的Mac电脑上的GoLand。
2.1 构造头部文件注释模板
打开GoLand,选择`GoLand => Prefences => Editor` 下的`File And Code Templates`:
选择Includes
,创建一个名为File Header
的文件:
配置如下:
// Package ${GO_PACKAGE_NAME}
// @Author: Joe.Wu
// @File: ${NAME}.go
// @Date: