《代码整洁之道》三

第四章讲的是注释,

法律信息。
提供信息的注释
阐释。 有时注释把某种晦涩难明的参数或返回值的意义翻译为某种可读形式。也会是有用的。特别是参数或者返回值是某个标准库的一部分,或者你不能修改代码,那帮助阐释其含义的代码就会有用,例如:assertTrue(bb.compareTo(ba)==1);//bb>aa

直接看方法可能不明确,但有注释就明白多了。我看这2,3,4都是一个意思。就是说明是干嘛的。

.警示,告诉别人要注意这个方法之类的。

6放大。有的代码可能看着有点多余,但编码者当时是有他自己的考虑,这个时候需要注释下这个代码的重要性。避免后面被优化掉。

原文地址:https://www.cnblogs.com/xk1013/p/14219618.html