代码整洁之道总结

整洁规则

(一)时时保持代码整洁

(二)有意义的命名

1、使用有意义的命名,有更好的命名随时替换
2、使用可搜索的名称
3、不需要使用前缀或后缀
4、类名和对象名应该是名词或名词短语
5、方法名应该是动词或动词短语
6、别用双关语,做到一词一义
7、添加有意义的语境

(三)函数

1、函数第一规则是要短小
2、代码块和缩进(if、else、while等语句,其中代码块应该只有一行)
3、函数应该做一件事,做好这件事,只做这一件事
4、最理想的函数参数是零
5、抽离try/catch代码块的主体

(四)注释

1、注释要少量而有力的表达
2、用代码来阐述
3、好注释包括法律信息、提供信息、警示、todo形式等
4、坏注释包括多余的、误导性的、归属与署名、注释掉的代码

(五)格式

1、垂直方向上使用空白行隔开
2、水平方向上使用空格隔开
3、while和for语句的语句体不为空

(六)对象和数据结构

1、得墨忒耳律---模块不应该了解他所操作对象的内部情形
2、火车失事---连串的调用被认为是很肮脏的风格
3、最为精炼的数据结构,是一个只有公共变量、没有函数的类

(七)错误处理

1、使用异常而非返回码
2、

你可能感兴趣的:(计算机科学)