代码整洁之道
Posted 响马
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了代码整洁之道相关的知识，希望对你有一定的参考价值。
一、有意义的命名
- 名副其实
- 避免误导
- 使用统一标记风格(Pascal或Camel)
- 别用双关语
- 添加有意义的语境(上下文)
二、函数
- 短小
- 只做一件事
- 名称有意义，使用描述性名称。
- 合理使用switch和if
- 别重复自己，多提取公共函数
三、注释
- 最好的注释是没有注释
- 最好的注释是有意义的命名。
- 好注释描述问题
- 坏注释胡言乱语
- 及时更新注释别出现上条问题。
- 坏注释不如无注释，不能保证注释新鲜，删除注释。
四、格式
- 代码排版上下有间隙
- 代码左右长度不要超过屏幕宽。
五、错误处理
- 错误时抛出异常
- 先写try-catch-finally语言
- 别返回null,别传递null
六、边界定义
- 不重复造轮子，合理使用第三方代码
- 系统添加防腐层
七、单元测试
- 只有通过单元测试的代码才是正在Clean
- 上述6条只是表面干净
八、类
- 类应该短小
- 单一权责
- 内聚
九、系统
- AOP
- ASP
- DI和IOC
以上是关于代码整洁之道的主要内容，如果未能解决你的问题，请参考以下文章