这是我参与「第五届青训营 」伴学笔记创作活动的第 3天
1.前言
编程语言给开发者提供便利,为了使代码正确可靠,简洁清晰,我们需要学习编程规范让我们写出优雅的高质量代码。
2.编码规范
各色语言和其特性均有不同,但高质量代码的原则是相通的,主要有如下三点:
1.简单性:消除代码不必要的复杂性。 2.可读性:编写可维护性高的代码第一要素就是代码可读。 3.生产力:团队协作,增加效率。
2.1 代码格式:
gofmtGo官方提供的工具,能自动化Go语言代码为统一风格。
2.2 注释
go的注释分为两种,单行注释及多行注释
//
/*
*/
代码注释应表明代码目的,原因,上下文联系,error原因等。 特别注意,对公共的功能注释描述它的功能和用途. 只有在函数的功能简单而明显时才能省略这些注释。
2.3变量
-
【规则】简洁胜于冗长
-
【规则】变量命名遵循驼峰法
-
【规则】缩略词全大写
-
【说明】首字母不需要导出时使用小写
-
【建议】对于常规缩略语,一旦选择了大写或者小写的风格,就应当在整份代码中保持这种风格,不要首字符大写和缩写两种风格混用。
2.3 package
- 【规则】包名不要与标准库重名
- 【规则】包名为全小写单词,不使用复数,不使用下划线
- 【建议】包名应该尽可能简短
2.4 控制流程
处理逻辑尽量走直线,避免复杂的嵌套分支Go 语言代码不是成功的路径越来越深地嵌套到右边,而是随着函数的执行,正常流程代码会沿着屏幕向下移动一个功能如果可以通过多个功能的线性结合来实现,那它的结构就会非常简单。
如果能让正常流程自上而下、简单清晰地进行处理,代码的可读性就会大幅提高,与此同时,可维护性也将提高,添加功能等改良工作将变得更加容易故障问题大多出现在复杂的条件语句和循环语句中,在维护这种逻辑时,添加功能会变成高风险的操作,很容易遗漏部分条件导致问题