代码整洁之道

1.一次只做一件事的原则

除了最外边必要的空判断,少用return操作符。
原则如下图所示:


一次只做一件事情.png
具体的操作方法:

1)将一个难于理解的大方法里面都做了哪些事情列举出来。
2)将分散的事情集中到一起处理。


7F9BE455-319C-4448-B202-F2C2C661A553.png

2.代码越少越好

具体要做到
每隔一段时间花15分钟来阅读标准库中的所有函数/模块/类型的名字。
好习惯读库。
使用Unix工具而非编写代码。
1.从项目中消除不必要的功能,不要过度的设计。
2.重新考虑需求,解决版本最简单的问题,只要能完成工作就行。
3.经常性地通读标准库的整个API,保持对它们的熟悉程度。

3.创建通用的代码库

命名可以用util
把一般代码和项目专有的代码分开。

4.拆分超长的表达式

1)用作解释的变量。
2)用作总结变量。

5.写出言简意赅的注释

1.避免使用不明确的代词。
例如:Insert the data into the cache,but check if it's too big first。
改成:Insert the data into the cache,but check if the data is too big first。
2.精确地描述函数的行为
如果一个函数统计了一个文件中的行数:
例如:Return the number of lines in this file。
改成:Count how many newline bytes ('\n') are in the file.


注释.png

6.审美

1."相似的代码应该看上去相似”原则。
2.在需要的时候使用列对齐。
3.把声明按照块组织起来。
4.把代码分成“段落”。
5.个人风格的一致性。

7.不会误解的名字

关键思想:多问自己几遍,这个名字会被别人误读成其他的含义码?

你可能感兴趣的:(代码整洁之道)