注释

• 与其花费更多时间在编写注释上，不如多思考如何能够使代码更加整洁、更能体现其意义。
• 如果代码本身的意义足够清晰明了就没有必要再去编写无意义的注释。
• 注释不要说谎。
• 法律信息、著作权声明等。
• 使用注释来说明方法返回值、参数等，但是这可以使用良好的命名来解决。
• 使用注释来阐明某种写法的目的或者解决方案。
• 使用注释将某些复杂的、不易理解的值翻译为某种更加可读的形式。
• 通过注释警告什么时候该使用这段代码或者是这段代码存在何种问题。
• 添加TODO注释对这段代码的未来功能规划作出解释。
• 注释可以用来放大某种看来不合理之物的重要性。
• 注释要让他人轻松的看明白，注释要和它所阐述的代码有紧密关系。
• 注释不应当不如阅读代码清晰，也就是多余。
• 注释必须准确的描述代码的实际行为，误导的注释是有害的。
• 没有必要一定要为每个变量、每个方法都增加Java doc注释。
• 杜绝日志式注释。
• 对于显而易见的问题没有必要添加注释，这将看起来像是废话。
• 没必要保留的代码应当删除而不是注释。
• 注释中的信息不宜过多。