原则就是:
1、对外模块公共的API需要提供正确、规范的JavaDoc2、自己模块使用的API,最好不用注释,因为代码一直在修改,在重构,可是注释却没有人维护。
错误的注释或者坏的注释会带来巨大的损失。
3、所以要求我们写的代码具有足够的表达力,用代码代替注释。
4、自从敏捷开发以后,模块的说明文档已经不存在了。和注释一样,代码一直在改,在重构
但是文档却没有,并且写文档会耗费大量的时间,所以呢,直接看代码,代码是最真实的信息
是不会骗人的。
5、TOOO注释也不需要。
6、如果觉得心里没底,需要写注释,那么请想想,如何把代码写的更具有表达力。