代码格式规范的List

《代码大全》是本好书啊,推荐所有有志于改善自己的程序,或者在编码上寻找进一步提高的人应该仔细研究研究。以下是摘抄自《代码大全》第二版中谈到关于怎样的代码格式更适合人类阅读,更能令人愉悦的Check List。对照List进行自检和反省,令人欣慰的是List中80%以上我都做到了,在我的上一个项目中做得比较失败,由于时间的原因,很多注释没有加上,逻辑也不够清晰。在重构中解决,借此反省。
一般问题:
格式化主要是为了展现代码的逻辑结构吗?
2、你的布局方案能统一运行吗?
3、 你的布局方案能让代码易于维护吗?
4、你的布局方案是否有利于代码的可读性?
控制结构的布局
1、你的代码中避免begin-end 或对{}的双重缩进了吗?
2、相邻的块之间用空行分割了吗?
3、对复杂表达式格式化时考虑到可读性吗?
4、对只有一条语句的块布局始终如一吗?
5、case语句与其他控制结构的格式化保持一致了吗?
6、对goto语句格式化是否让其显眼了呢?
还好目前PHP只有5.3以上版本才会有goto
单条语句的布局:

1、为逻辑表达式、数组下标和子程序参数的可读性使用了空格了吗?
2、不完整的语句在行末似乎以明显又错的方式结束吗?
3、后续行按照标准数码缩进了吗?
4、每行顶多只有一条语句吗?
这一点是团队中比较头痛的问题,很多人不按照这个规则来做,结果它成了一种风气
5、所写的每个语句都没有副作用吗?
6、每行顶多只声明一个数据吗?
注释布局:
1、注释与其所注释的代码所尽量相同吗?
2、注释风格便于维护吗?
子程序的布局:
1、你对每个子程序的参数格式化方式便于看懂、修改、注释吗?
2、采用空行分割子程序各部分了吗?
4、文件中子程序用空行清楚分开了吗?
5、在没有更好的组织形式的场合,所有子程序都按字母排列了吗?
这一点我没有做到,没有做到是没有想到这一点,以后编码注意了……

相关文章


One Response to “代码格式规范的List”

  1. g.zhen.ning 说:

    你看书速度很快啊。

    [Reply]

Post a Comment