Closed ronething-bot closed 2 years ago
新增的函数,需要对函数体的整体逻辑, 函数体的入参,返回值做详细说明,建议用 // 逐行注释,并且以函数名开头
函数体里的关键需加上行注,用 // 开头的单行注释
新增的结构体定义,需要对结构体的含义以及里面每一个字段做详细说明,结构体的整体说明使用 // 逐行注释,并且以 以结构体的名字开头,结构体字段的说明使用 // 逐行注释,并且使用结构体字段名字开头。
新增的接口定义,需要对接口定义做详细说明,接口的整体说明使用 // 逐行注释,并且以接口的名字开头,接口里每个方法说明 使用 // 逐行注释,并且使用接口方法的名字开头。
如果你的包引入了三种类型的包,标准库包,第三方包,程序内部包,建议采用标准库包,第三方包,程序内部包的顺序组织你的包
https://github.com/cloud-org/edge-proxy/commit/b432c53bd41d3ac86a5092888dc99bf6d1e87ffb
新增的函数,需要对函数体的整体逻辑, 函数体的入参,返回值做详细说明,建议用 // 逐行注释,并且以函数名开头
函数体里的关键需加上行注,用 // 开头的单行注释
新增的结构体定义,需要对结构体的含义以及里面每一个字段做详细说明,结构体的整体说明使用 // 逐行注释,并且以 以结构体的名字开头,结构体字段的说明使用 // 逐行注释,并且使用结构体字段名字开头。
新增的接口定义,需要对接口定义做详细说明,接口的整体说明使用 // 逐行注释,并且以接口的名字开头,接口里每个方法说明 使用 // 逐行注释,并且使用接口方法的名字开头。
如果你的包引入了三种类型的包,标准库包,第三方包,程序内部包,建议采用标准库包,第三方包,程序内部包的顺序组织你的包