Skip to content

一键给go项目加注释,妈妈再也不用担心我被代码评审的机器人打屁股

Notifications You must be signed in to change notification settings

dalianzhu/commentHelper

Repository files navigation

给go加注释

这玩意用来干嘛的呢? 给go文件加一些其实没必要的注释。放心,如果原来有注释,不会重复添加,安全无污染 而且,超过120个字的行,会尝试折行,也就是在非string/注释的 , (后添加换行符。

比如:

const LineID = "lineId"

const HandleFullErr = QueueErrType("handleFullError","handleFullError","handleFullError","handleFullError","handleFullError","handleFullError")


func Init() {
...
}

type TStruct struct {
}
func (t *TStruct) Get() (*TSnmpSubsvr, error) {
}

处理后: commentHelper /path/file.go

会变成:

// LineID ...
const LineID = "lineId"

// HandleFullErr ...
const HandleFullErr = QueueErrType(
    "handleFullError",
    "handleFullError", "handleFullError", "handleFullError", "handleFullError", "handleFullError")

// Init ...
func Init() {
...
}

// TStruct ...
type TStruct struct {
}

// Get ...
func (t *TStruct) Get() (*TSnmpSubsvr, error) {
}

做这个有啥用

因为最近部门在搞代码评比,扫描出来公有变量不加注释是会报警的。 所以,用来骗骗机器。

其次,先自动生成个注释在这占个位,说不定你心情好的时候,也会补充下嘛。

usage

git clone https://github.com/dalianzhu/commentHelper.git
cd commentHelper
go build github.com/dalianzhu/commentHelper
# 得到 commentHelper
mv commentHelper /usr/bin
chmod 777 /usr/bin/commentHelper
# 使用
commentHelper /path/file.go

# 对目录
commentHelper /path/
# 将处理所有/path/下的go文件,忽略.pb.go

About

一键给go项目加注释,妈妈再也不用担心我被代码评审的机器人打屁股

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages