代码整洁之道：想要成为一个更好的程序员，你要注意这些方面

在我们的认知里，工程师和程序员是有区别的，程序员是属于那种做什么事情都是按部就班，没什么独立思考能力。但其实，程序员也可以看做是工程师，他们有工程师的思维，做一个项目需要考虑全局。

编程和写作都是在构建自己的世界，作家可以用文字构建自己的世界，在那个世界里，他想要什么样的角色，自己去生成。编程跟写作有共通之处，编程也是在构建自己的虚拟世界，在这个世界里可以去做一些他想做的事情。

跟文字一样，编程语言没有高低之分，真正的工程师需要掌握多种语言，工程师的作用就是他知道这个地方用什么语言实现最好。

 

 

但是除了会写代码，代码的整洁程度也很重要。这不仅仅让自己理清思路，也能方便他人看懂我们的代码，提高效率。

普通的工程师堆砌代码，优秀的工程师优雅代码，卓越的工程师简化代码。如何写出优雅整洁易懂的代码是一门学问，也是软件工程实践里重要的一环。

一本很有名的书籍《代码整洁之道 》，推荐大家去看看。

本篇文章重点将从注释、命名、方法、异常、单元测试等多个方面总结了一些代码整洁最佳实践。

 

注释

• 不要给不好的名字加注释，一个好的名字比好的注释更重要

• 不要“拐杖注释”，好代码 > 坏代码 + 好注释

• 在文件/类级别使用全局注释来解释所有部分如何工作

• 一定要给常量加注释

• 团队统一定义标记

TODO 待处理的问题
FIXME 已知有问题的代码
HACK 不得不采用的粗糙的解决方案

• 在注释中用精心挑选的输入输出例子进行说明

• 注释应该声明代码的高层次意图，而非明显的细节

• 不要在代码中加入代码的著作信息，git可以干的事情不要交给代码

• 源代码中的html注释是一种厌物, 增加阅读难度

• 注释一定要描述离它最近的代码