formatting - 好的评论用例

Question

我一直讨厌用星号填满一半屏幕的评论，只是为了告诉你函数返回一个字符串，我从来没有看过那些评论。

但是，我确实阅读了描述为什么完成某事以及如何完成的注释(通常是代码中的单行注释)；这些在试图理解别人的代码时非常方便。

但是在写评论的时候，我不这么写，而是我只在编程比赛中写算法时才使用评论，我会想到算法会如何做，然后我会写每个注释中的一个，然后编写与该注释对应的代码。

一个例子是:

//loop though all the names from n to j - 1

除此之外，我无法想象为什么有人会在可以编写代码的时候浪费宝贵的时间来写评论。

我是对还是错？我错过了什么吗？我不知道还有哪些其他好的评论用例？

Answer 1

评论应该表达为什么你在做某事而不是你在做什么