您是否认为需要注释代码，除非是 API？
我的意思是，一个很好的代码。具有自我解释的变量和方法。
有必要评论一个好的代码吗？
谢谢。
问问题
111 次
1 回答
1
这是一个很好的问题，但也非常主观。如果您编写了非常可靠的代码并拥有一个设计良好的应用程序，那么它的几乎每个部分都是不言自明的（自文档化）。但是，在你驳回评论之前，问问自己是否真的如此。
也就是说，好的注释通常会阐明代码、包、类的更大意图；它们对您正在做的事情提供更高层次的概述，而不是仅仅“解释”几行。当然，对难以理解的代码（复杂的算法）进行注释是很有用的。
无论如何，如果您的代码仅供私人使用并且您的项目范围有限，您不必在代码中乱扔注释，当您认为需要澄清时，只需直观地放置注释即可。当您稍后回到一段代码并不得不修改它时，您通常会很高兴。
于 2012-04-14T13:45:42.273 回答