代码整洁之道读书笔记----第四章---注释--第一节-什么是好注释如何写好注释(2018-07-31)

真正好的代码是不需要注释的


这里写图片描述
先别急着锤我,听我解释,虽然说真正好的代码是不需要注释的,但是这是在理想情况下的。为什么说真正好的代码不需要注释,因为整洁的代码读者可以根据类名,方法名,变量名,非常轻易的就理解了作者的意图。


什么是值得写的注释

提供反馈信息的注释
比如解释某个方法的返回值。

//Returns an instance of the Responder being tested.
protected abstract ResponderInstance();

但是更好的方式是尽量通过函数名称传递信息。

protected abstract responderBeingTested();

对意图的解释
此部分代码所做的事情,这部分务必要准确,而且要随着代码的更改及时更新


警示性的
比如像这种的

// Don't run unless you have some time to kill.

TODO注释
TODO是一种程序猿认为应该做的,但是由于某些原因目前还没做的工作。


FIXME注释
注释中用FIXME标记某代码是错误的,而且是不能工作的,需要及时纠正了。

猜你喜欢

转载自blog.csdn.net/qq_33121481/article/details/81316888