在街上，我看到人们说，“你应该写评论”或“不，你不必这样做”。
让我们练习写评论
为了写出好的评论，你需要有写很多评论的经验。它与普通代码、测试代码、文档等相同。
但是，似乎没有写很多评论的人在说，“如果……你不需要评论”。
这就像一个几乎从未写过测试代码的人说，“如果……你就不需要测试代码”，你根本不能相信它。
发表评论。
其次，经常有这样一个故事，像下面这样的评论不必写，因为它们没有意义。
list.add(user); // ユーザをリストに加える
事实上，这样的评论往往毫无意义。
但就像代码一样，首次评论者的评论质量很差也就不足为奇了。
别担心，继续写。你将能够写出好的评论。
借口之一是注释和代码不匹配，所以我看到一个故事，最好不要有注释。
也许如果你和一个没有评论的团队一起开发，但通常评论会指出这一点。
即使你错过了它，也只是在你注意到它时修复它，就像错误和错别字一样。
此外，不仅注释，规范、设计和配置图也可能与代码不同。
但是，既然有分歧的可能，除非是个人开发，否则说没有规格、没有配置图，这不是不合理的态度吗？
写文档评论
如果此列表没有元素，则返回 true。
数组列表#isEmpty即使是通过函数名可以清楚识别并且不会产生误导的函数，写文档注释也是很自然的。让我们写。
您可能会认为这是不必要的，因为它不是公共图书馆。但是，如果每个程序员都考虑它们是否有必要，那就把它们都写下来。如果你开始认为你可以从函数名上看出来，你会逐渐变得懒惰。当我尝试编写文档注释时，我无法很好地解释它，结果，我有时会发现函数本身很复杂。
评论写的有点多
在写评论的时候，我觉得很常见的感觉是，“好吧，你只要看代码就可以理解它。”
但是，仅仅因为您，最熟悉规范的实施者可以看到它，并不一定意味着第一个审阅者或下一个修改代码的人会立即知道它。
如果你理解“要做A，你需要写代码B”，注释A似乎是多余的，
其实理解是需要时间的。减少其他人的时间。
原创声明：本文系作者授权爱码网发表，未经许可，不得转载;
原文地址：https://www.likecs.com/show-308622568.html