征求意见的文件

Question

我写了一个应用程序，里面有很多评论。

这可能有点不寻常，但是我想知道Visual中是否有一种方法可以将注释优雅地安排在一个专用文件中。还是有一种方法可以在文本文件中的某个地方写入文本呢？

的确，使用注释是很棒的，但是我的代码仍然很拥挤。

目前，我计划为注释使用一个新的类，它将只包含注释，其中包含有关代码部分的详细信息。

如果你有更好的想法，非常感谢你分享它。

Answer 1

我怎么强调也不为过这是个多么糟糕的主意。

代码注释最好：

1. 接近他们所关注的代码
2. 简简单单
3. 使用谨慎--代码经常会发生变化，注释可能很快就与此不同步，然后在您知道注释所做的弊大于利之前。

如果确实有一些functional解释，例如为什么需要，以及是如何工作的，而不是如何使用，那么我建议编写一个文档来解释这一点。

有各种各样的方法可以做到这一点：

1. 共享系统上的Word文档(例如网络驱动器/ sharepoint)
2. 一个在线/内部的wiki系统(例如亚特兰蒂斯汇合点，或GitHub wiki)

(举几个例子)

不过，根据其他用户的建议，您应该确保没有太多的评论，因为它们只是添加噪音(这是您明显发现的)。

Sidenote:我曾经为一家公司工作，坚持使用注释everywhere，每个函数都必须有一个带有其名称、签名和编辑历史记录的横幅注释(尽管我们使用了源代码控制)，几乎每一行代码都必须被注释以说明它在做什么(据推测)。如果你处于类似的状态，也许试着解释一下这会导致什么问题？