单独的代码和评论

Question

我发现代码的评论开始变得烦人.我觉得一旦你获得了一定程度的专业知识,代码几乎就是自我记录.但评论仍然是必要的.我想知道是否有这样的插件或IDE将这种意见的想法与代码分开.如果不存在这样的事情,你认为哪些想法对像Eclipse这样的IDE插件有用？

以此Python代码为例:

def do_something(self, var):
    # * 541
    ...

然后像这样的一些XML:

<comments>
 <comment id="541" file="x.py" line="14">This is a comment</comment>
<comments>

谢谢!

Answer 1

我从来没有听说过外部化评论这样的事情,我认为它们很慢或很容易被破坏,因为它们总是需要更新才能与代码保持同步.此外,如果您的想法是在处理代码时完全消除它们的视图,您可能会忘记更新它们,它们可能会变得不准确.

您应该研究的一个功能是代码折叠.当您不想查看它们时,它们会折叠成较小的空间,而不是将注释分成不同的文件.许多IDE实现它(eclipse是一个).