goProject/trunk/goutil/doc/Code Specification.txt

9 lines
1.2 KiB
Plaintext
Raw Normal View History

2025-01-06 16:01:02 +08:00
#go语言项目约定
1、如果在函数内部出现错误需记录该错误然后抛出错误直至回退到函数最外层进行处理。(对于项目初始化的函数还需调用panic结束协程
2、对于包内逻辑独立完整的类型才需建立子包单独存放;对于其他情况,请在同一级包内进行处理。(注意:包与文件夹概念不同,轻易建立子包会造成数据与接口的暴露)
3、对于变量一律以小写开头如果该变量需要对包外提供提供Get,Set接口进行数据访问。
4、对于常量如果该常量仅包内可见前缀小写con_如果包外可见前缀大写Con_
5、对于自定义类型如果仅包内可见小写开头如果包外可见大写开头。类型内部字段名默认小写开头需要序列化的字段大写。
6、对于通道chan,如果仅包内可见,小写开头;如果包外可见,大写开头,此处不提供接口访问。
7、在函数参数中出现的变量若与包内数据同名统一以_开头加以区分。
8、对于需要向包外提供的数据如果不需要修改统一返回副本如果需要在包外修改请返回指针。