Go 命名规范
内容整理仅为个人当做笔记使用,无论是对于内容对错还是其他问题都可以联系我进行修改。
同时发现内容不对的地方也欢迎各位大佬对我进行指指点点
1、项目名
当我们不清楚项目命名规则的,我们看看大佬的项目都是如何命名
例如:
“github.com/go-redis/redis”
“github.com/beego/beego/v2/server/web”
“github.com/gin-gonic/gin”
从上面的导包记录看首先确定的是项目名都是小写,然后看路径中的命名规律,也都是小写,如果是多个单词用-进行分割
具体规则何如应该不用多说了
总结:
1、全小写
2、-(减号)进行单词拼接
2、包名
包名一般和目录文件名一直
一般全为小写,要尽量地避免和标准库的包名相同
同时具有一定的意义最佳
例如:main、test、routers、xiaoyin …
总结:
1、全小写
2、短小精炼
3、文件名
跟包名的差不多,文件名中的字母还是都需要小写
如果文件名设计的单词比较多那么可以使用下划线 _ 进行拼接
例如:demo1_test.go、demo2_test.go、xiaoyin_code.go …
总结:
1、全小写
2、_(下划线)进行拼接
4、结构体
使用驼峰命名法、首字母大小写进行控制访问权限
例如:
type XiaoYin struct {
}
总结:
1、驼峰命名法
2、首字母大写(大驼峰) ==> public 可以被外部包访问
3、首字母小写(小驼峰) ==> private 不可以被外部包访问
5、接口
使用驼峰命名法、首字母大小写进行控制访问权限
例如:
type XiaoYin interface {
}
总结:
1、驼峰命名法
2、首字母大写(大驼峰) ==> public 可以被外部包访问
3、首字母小写(小驼峰) ==> private 不可以被外部包访问
6、变量名
使用驼峰命名法、首字母大小写进行控制访问权限
若变量类型为 bool 类型,则名称应以 has, is, can 或 allow 开头
例如:
var mStr string
var mTempi int
var isClose bool
总结:
1、首字母大写 对应其他语言 public 可以被外部包访问
2、首字母小写 对应其他语言 private 不可以被外部包访问
7、常量
一般都是全部大写,然后多个单词之间用_(下划线)进行拼接
例如:
const XIAO_YIN = 0
const XIAO_YIN_CSDN_URL = "https://blog.csdn.net/qq_44111597"
一点点笔记,以便以后翻阅。