代码简洁之道-->注释与格式

注释

按照代码简洁之道里面的说发，好的代码应该是没有注释的。只有表达不清楚含义，才需要用注释去辅助。
这只是理想情况，现实往往不是这样的。国人英语水平，每个人的思维方式等等这些限制条件导致我们的代码是应该有注释的。注释的规范应该是怎么样的呢？一下纯属我个人的理解。

• 类注释
  每一个类都应该有注释，告诉别人你这个类是干什么的。
• 实体类里的属性
  实体类里面的每一个属性都应该是有注释的，国人起得名字很难做到见名知意。
• 方法的注释
  每一个方法最好都要做简单的说明，让人知道你这个方法干了什么。现在方法的参数多余三个以上都可能用对象了，因此在实体里面的注释也更显得有必要了。
• 复杂逻辑的注释
  复杂的逻辑最好写一下注释，告诉别人你的实现思路。不过一定要注意，如果实现方式有改动一定要修改注释，不然就会造成注释是注释实现是实现。

格式

按照代码简洁之道的说法，代码的格式应该是团队的格式。这个应该是所有格式的大前提。如果每一个人都是一种风格，那这个代码后期的维护会是一种灾难。
对于代码的格式我做一些自己浅显的理解：

• 团队风格统一
• 缩进换行使用format格式化
• 代码是有码距的，变量的申明应该最靠近使用，也就是码距最小

总结起来，注释和格式都是我们日常写代码应该注意的，从小处入手，养成良好的习惯，才能写出优雅的代码。