Ide 单独的代码和注释

我发现代码上的注释开始变得烦人。我觉得，一旦您获得了某种程度的专业知识，代码基本上就是自文档化的。但评论仍然是必要的。 我想知道的是，是否有这样一个插件或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>

这是一个评论

---

谢谢

唐纳德·克努特（Donald Knuth）以“有文化的编程”（这是谷歌搜索的一个良好起点）为题深入探讨了这个话题。他编写了一个名为Weave（或者是Web？）和Tangle的程序，它的功能类似于您所要求的，但用于Pascal代码

恐怕这个想法从来没有离实际太远，我也从来没有听说过类似的Python

现在，有一个程序员社区，他们相信编写具有足够描述性的名称和变量名的短方法，以使注释（通常）变得不必要。我们其余的人只是缓慢地走着，评论我们一贯的做法

更新

---

我撒谎了！这里有一种叫做派利特的东西：。此外，还对整个事件进行了相当广泛的讨论。

唐纳德·克努特（Donald Knuth）以“识字编程”（这是谷歌搜索的一个良好起点）为题深入探讨了这个话题。他编写了一个名为Weave（或者是Web？）和Tangle的程序，它的功能类似于您所要求的，但用于Pascal代码

恐怕这个想法从来没有离实际太远，我也从来没有听说过类似的Python

现在，有一个程序员社区，他们相信编写具有足够描述性的名称和变量名的短方法，以使注释（通常）变得不必要。我们其余的人只是缓慢地走着，评论我们一贯的做法

更新

---

我撒谎了！这里有一种叫做派利特的东西：。另外，对整个事情进行了相当广泛的讨论。

好的评论会添加信息，例如为什么，它们不会重复代码，因此我不同意这个问题的前提

---

然而，暂时同意这个想法，我可以想象一个IDE，它在编辑时隐藏注释，但是单独存储它们会造成混乱

好的评论会添加信息，比如为什么，它们不会重复代码，所以我不同意这个问题的前提

---

然而，暂时同意这个想法，我可以想象一个IDE，它在编辑时隐藏注释，但是单独存储它们会造成混乱

不要忘记，好的注释解释了意图和结果，而不是字面上的代码在做什么

---

话虽如此，您是否研究过IDE中的代码折叠？Eclipse（例如）将删除并隐藏它们。你只需按一下按钮就可以看到它们。注释保留在代码中，并与相关部分联系在一起，没有任何间接性（如您所建议的），因此您可以在任何编辑器/环境中查看它们。

不要忘记，好的注释解释的是意图和结果，而不是字面上的代码在做什么

---

话虽如此，您是否研究过IDE中的代码折叠？Eclipse（例如）将删除并隐藏它们。你只需按一下按钮就可以看到它们。注释保留在代码中，并与相关部分绑定，没有任何间接性（如您所建议的），因此您可以在任何编辑器/环境中查看它们。

我从来没有听说过外部化注释这样的事情，我认为它们会很慢或很容易损坏，因为它们总是需要更新才能与代码保持同步。此外，如果您的想法是在编写代码时从视图中完全消除它们，那么您可能会忘记更新它们，它们可能会变得不准确

---

您应该研究的一个特性是。当您不想查看注释时，它们会被折叠到更小的空间中，而不是将注释分离到不同的文件中。许多IDE都实现了它（eclipse就是其中之一）。

我从来没有听说过外部化注释这样的事情，我认为它们会很慢或者很容易损坏，因为它们总是需要更新才能与代码保持同步。此外，如果您的想法是在编写代码时从视图中完全消除它们，那么您可能会忘记更新它们，它们可能会变得不准确

---

您应该研究的一个特性是。当您不想查看注释时，它们会被折叠到更小的空间中，而不是将注释分离到不同的文件中。许多IDE都实现了它（eclipse就是其中之一）。

大多数编辑器都可以使用的快速修复方法是更改语法高亮显示颜色方案，使注释不可见或几乎不可见，例如白色背景上的浅灰色文本

---

如果您的编辑器支持多种颜色方案，那么您可以使用一种颜色方案隐藏注释，另一种颜色方案隐藏除注释以外的所有内容，然后在它们之间进行切换。

大多数编辑器都可以使用的快速修复方法是更改突出显示颜色方案的语法，使注释不可见或几乎不可见，例如，白色背景上的浅灰色文本

---

如果您的编辑器支持多种颜色方案，则可以使用一种颜色方案隐藏注释，另一种颜色方案隐藏除注释以外的所有内容，然后在它们之间切换。

如果注释不必要，则Delete键应将其与代码完全分开。如果评论有用，你可能不想让它看不见。就个人而言，我宁愿做一名污水处理技术员，也不愿像那样用XML来包装我的评论。但我确实相信，让好的老大学试试这个问题！卡尔，XML只是一个例子，我以前会自杀