Clean Code之路——命名

最新推荐文章于 2022-08-22 23:18:22 发布

原创最新推荐文章于 2022-08-22 23:18:22 发布 · 390 阅读

0 ·

CC 4.0 BY-SA版权

本文介绍了代码命名的基本原则，强调了命名的清晰性和准确性对于提高代码可读性和维护性的重要性。建议使用有意义的名字，避免数字常量直接出现，减少名字中的误导信息，并推荐了一些具体的实践方法。

命名基本原则

此处名字包括变量名、常量名、函数名、方法名、类名等。

名字在文字上应具有意义，主要要说明是干什么的，一个好的命名是不需要注释的。例如：

# unmeaningful name
d = 20 # elapsed time in days  
# meaningful name
elapsed_time_in_days = 20

代码不仅要能运行，还能让自己和别人很快读懂，如果能把代码写成文章段落那样易读，就最好了。
名字的长短决定于使用的单词是否能准确表达其意义，又没有文字冗余。

具体方法论

尽量不要在程序中使用数字常量，而是定义常量名，例如

# digit
if address[2] == 'China':
    pass
# constant name
if address[STATE] == 'China':
    pass

不要在名字中包含具有误导性信息的文字，如除非是一个列表类型的变量，否则不要使用account_list这种命名，可以使用accounts。
避免区分度不大的长名字，如logger_file_handler和logger_std_handler。
不要用数字作为后缀命名，如[a1, a2, a3, …, an]，而是使用具有区分度的单词命名。
不要在变量名中包含类型信息，因为不知道什么时候可能改变这个变量类型，这时候名字中的类型和真实类型会产生不一致。例如，不要使用address_string，而用address即可。
不要在名字中包含冠词a, the等，没有意义。
使用能发音的单词作为名字，以求交流之方便，因为编程也是一种社会行为，有时候需要多人协作。
使用能够快速搜索定位的名字，如果一个变量的名字是e，则搜索e将得到很多结果，无法快速定位。
不需要使用前缀后缀来说明名字的意义，如用m_address说明是成员变量，f_set_address说明是函数，没有必要的。
类名用名词或名词短语，方法名用动词或动词短语。
在代码中坚持用一个单词代表一个意思，并坚持使用这一个词，不要引入同义词，如只使用get，而不要一会儿get一会儿fetch。除此之外，还应了解约定俗称的命名习惯，例如append方法不能命名为add。
如果一个名字单独理解有歧义，则可以添加上下文前缀，或者干脆用封装一个新的类，用类名确定上下文。例如只看到state这一变量，不知道是“国家”还是“状态”的意思，如果添加前缀addr_state，就知道是“国家”的意思。