代码整洁之道 - 有意义的命名

mengbo 发布于2019-08-01 17:31 / 3204人阅读

摘要：我们这里再介绍一下，朱重八家族的名字，都很有特点。取这样的名字不是因为朱家是搞数学的，而是因为在元朝，老百姓如果不能上学和当官就没有名字，只能以父母年龄相加或者出生的日期命名。所以说命名不仅仅是一种科学，更是一种艺术。

在小朱元璋出生一个月后，父母为他取了一个名字（元时惯例）：朱重八，这个名字也可以叫做朱八八。我们这里再介绍一下，朱重八家族的名字，都很有特点。
朱重八高祖名字：朱百六；
朱重八曾祖名字：朱四九；
朱重八祖父名字：朱初一；
他的父亲我们介绍过了，叫朱五四。
取这样的名字不是因为朱家是搞数学的，而是因为在元朝，老百姓如果不能上学和当官就没有名字，只能以父母年龄相加或者出生的日期命名。（登记户口的人一定会眼花）--《明朝那些事儿》

那么问题来了，朱四九和朱百六是什么关系？你可能马上懵逼了。所以说：命名不仅仅是一种科学，更是一种艺术。

1 名副其实

// bad
var d; // 分手的时间，以天计算

// good
var daysAfterBrokeUp; // 分手以后，以天计算

2 避免误导

// bad
var nameList = "wdd"; // List一般暗指数据是数组，而不应该赋值给字符串

// good
var nameList = ["wdd","ddw","dwd"]; // 

// bad
var ill10o = 10; //千万不要把i,1,l,0,o,O放在一起，傻傻分不清楚

// good
var illOne = 10;

3 做有意义的区分

// bad
var userData, userInfo; // Data和Info, 有什么区别？？？？, 不要再用data和info这样模糊不清的单词了

// good
var userProfile, userAcount

4 使用读得出来的名称

// bad 
var beeceearrthrtee; // 你知道怎么读吗？ 鼻涕阿三？？

// good
var userName;

5 使用可搜索的名称

// bad
var e = "not found"; // 想搜e, 就很难搜

// good
var ERROR_NO_FOUND = "not found";

6 方法名一概是动词短语

// good
function createAgent(){}
funtion deleteAgent(){}
function updateAgent(){}
function queryAgent(){}

7 尽量不要用单字母名称, 除了用于循环

// bad
var i = 1;

// good
for(var i=0; i<10; i++){
    ...
}

// very good
userList.forEach(function(user){
    ...
});

8 每个概念对应一个词

controller和manager, 没什么区别，要用controller都用controller, 要用manager都用manager, 不要混着用

9 建立项目词汇表, 不要随意创造名称

user, agent, org, queue, activity, device...

参考资料

《代码整洁之道》

《明朝那些事儿》

GPU云服务器云服务器代码整洁 php 干净整洁维持整洁的 Git 提交记录有意义

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/51196.html

代码整洁之道 - 有意义的命名

摘要：我们这里再介绍一下，朱重八家族的名字，都很有特点。取这样的名字不是因为朱家是搞数学的，而是因为在元朝，老百姓如果不能上学和当官就没有名字，只能以父母年龄相加或者出生的日期命名。所以说命名不仅仅是一种科学，更是一种艺术。在小朱元璋出生一个月后，父母为他取了一个名字（元时惯例）：朱重八，这个名字也可以叫做朱八八。我们这里再介绍一下，朱重八家族的名字，都很有特点。朱重八高祖名字：朱百六；朱...

Cobub 2019-08-20 19:03 评论0 收藏0
《代码整洁之道》读书笔记

摘要：但大多数情况下应该尽量利用一些机制将二元函数转换成一元函数。应该为起一个更能描述函数功能的函数名副作用在于对这个调用函数，顾名思义，就是用来检查密码。注释及其描述的代码之间的联系应该显而易见。受控异常的代价就是违反开放闭合原则。大师级的程序员把系统当作故事来讲，而不是当作程序来写。 showImg(https://ws3.sinaimg.cn/large/006tKfTcgy1fs0...

pakolagij 2019-08-19 10:56 评论0 收藏0
代码整洁之道

摘要：在代码整洁之道，提出一种软件质量，可持续开发不仅在于项目架构设计，还与代码质量密切相关，代码的整洁度和质量成正比，一份整洁的代码在质量上是可靠的，为团队开发，后期维护，重构奠定了良好的基础。现在的软件系统开发难度主要在于其复杂度和规模，客户需求也不再像Winston Royce瀑布模型期望那样在系统编码前完成所有的设计满足用户软件需求。在这个信息爆炸技术日新月异的时代，需求总是在不停...

icattlecoder 2019-08-14 11:48 评论0 收藏0
《代码整洁之道》读书笔记

摘要：看完代码整洁之道之后我受益匪浅，但等到自己实践时却很难按照书中给的建议编写出整洁的代码。意味着新人除了了解代码逻辑之外，还需要学习这种编码语言。代码在演化，注释却不总是随之变动。区隔与靠近空格强调左右两边的分割。看完《代码整洁之道》之后我受益匪浅，但等到自己实践时却很难按照书中给的建议编写出整洁的代码。一方面是规则太多，记不住，另一方面书上引用了大量示例代码对这些规则进行佐证，在我记...

liangzai_cool 2019-08-19 11:47 评论0 收藏0