编码规范之命名规范

最新推荐文章于 2024-05-25 22:19:53 发布

秦羽

最新推荐文章于 2024-05-25 22:19:53 发布

阅读量517

点赞数

分类专栏： GO 文章标签： golang

本文链接：https://blog.csdn.net/qq_43585922/article/details/131360701

版权

14 篇文章 1 订阅

订阅专栏

$\textcolor{Green}{前言：}$

💞这个专栏就专门来记录一下寒假参加的第五期字节跳动训练营
💞从这个专栏里面可以迅速获得Go的知识

今天的笔记是昨天的补充，对编码规范中的命名规范进行总结。主要包含变量的命名规范、函数的命名规范、包的命名规范。通过学习我们可以对我们的命名进行统一，之后在项目开发过程中可以节约很长的时间，让更多的精力关注在实现上，而不是细枝末节中。

1.2.3 编码规范 - 命名规范

variale（变量）命名规范

简洁胜于冗长
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写。
- 例如使用 Server HTTP 而不是 ServerHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义。

例子：在 i 和 index 作用域仅在 for 循环内部时，变量名 index 没有增加对程序的理解，直接用最简单的 i 是最好的。如果索引的作用域扩展，在循环外也会用到时，就需要重新考虑更加符合需求的名称了

// Bad
for index := 0; index < len(s); index++ {
    // do something
}

// Good
for i := 0; i < len(s); index++ {
    // do something
}

再来一个例子：函数参数的名称示例，这里为了简短将时间参数 deadline 改成了 t，修改后发现降低了变量名的信息量。

t 常代指任意时间
deadline 常指截止时间，有特定的含义
函数提供给外部调用时，签名的信息很重要，要将自己的功能准确表示，自动提示一般会提示函数的方法签名，通过参数名更好的理解功能很有必要，节省时间。

// Good
fun (c * Client) send(req *Request, deadline time.Time)

// Good
fun (c * Client) send(req *Request, t time.Time)

function（函数）命名规范

例如图中的问题。

因为我们在实际调用过程中，调用 http 包的 Server 方法时，代码是 http.Server 携带有 http 包名，所以函数中无需添加包信息。

package（包）的命名规范

比函数高一层的就是包。接下来讲解对包的命名规范

以下规则尽量满足，以标准库包名为例

需要使用多个单词表达上下文的命名可以使用缩写，例如使用 strconv 而不是 stringconversion

包名也涉及到项目代码结构的划分和层次安排，具体名称不同项目会有细微差异，实际项目内风格统一。

阅读理解代码么时候会尝试模拟计算机运行程序，好的命名能让程序猿将更多的精力关注在主流程上，清晰地理解程序地功能，避免频繁地关注到分支细节上，增加了理解成本

Good naming is like a good joke. if you have to explain it, it’s not funny。
这句话地意思是好的命名就像一个好笑话。如果你必须解释它，那就不好笑了。 – Dave Cheney

关注

专栏目录