根本准则:阐明代码含义的首要途径应该是逻辑和结构清晰的代码,而非注释;非必要的注释最好不写;因为在代码更新的过程中原始的注释可能会变得没有意义甚至错误,所以注释写的越少越好。公共APi应该具有良好的javadoc注释TODO注释要记得定期删除实际没有使用的代码应该被删掉,而不是注释掉!注释应该“就近”,不要在局部注释中描述全局信息