你的位置:首页 > Java教程

[Java教程]Clean Code(三):注释


在工作中经常在刚开始写代码的时候,写下类与方法的注释,时间久了,CR多了,也不可能一直去修改注释了。加班都累成dog。注释才不改呢,就是这么任性,哈哈。

项目久了,注释会欺骗阅读者,本人被骗过,也骗过别人。

注释只是一种代码的补充,如果方法,类,变量命名好的话,一般不需要注释,它并不能美化代码,丑陋的代码经过N次CR之后,除了开发者无人能懂,注释就变成了毒药。

一般下列注释还是可以的:

法律信息:只要有可能,就指向一份标准许可或其他外部文档,而不是把所有条款放到注释中

提供信息的注释:比如某个抽象方法的返回值,某个map参数中的键值

对意图的解释:就是为什么要这么做,对下面的代码带来了什么样的影响

阐释:把某种难明的参数或返回值,翻译为可读的形式

警示的注释

公共的API,这个我觉得一定要有。