C# 评论文件

我写了一个有大量评论的应用程序

这可能有点不寻常，但我想知道Visual Studio中是否有一种方法可以在专用文件中优雅地排列注释。或者，是否有一种方法可以在文本文件中的某个位置写入文本

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

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

---

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

这是一个多么糟糕的想法

代码注释最好是：

接近他们关注的代码

简明扼要

代码经常更改，注释可能很快就会与此不同步，然后在您意识到之前，注释弊大于利

如果你真的想了解一些功能性的解释，例如为什么需要某个东西，以及它是如何工作的，而不是如何使用它，我建议写一篇文档来解释这一点

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

共享系统（如网络驱动器/sharepoint）上的Word文档

在线/内部wiki系统（例如Atlassian Confluence或GitHub wiki）

（说出一对夫妇的名字）

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

---

旁注：我曾经为一家公司工作，该公司坚持在任何地方都使用注释，每个函数都必须有一个带有名称、签名、编写者和编辑历史的横幅注释（即使我们使用了源代码管理），几乎每一行代码都必须注释以说明它是什么（假定）做。如果你的处境相似，也许可以试着解释一下这会导致什么问题？

我的第一个想法是“为什么”？为什么有这么多代码注释？或者亲自更好地解释它，或者重写它以便更容易理解，并且你不再需要它们，或者写一篇手册/博客文章来处理解释部分。这就是说，也许你应该使用并让一个文档工具为他们生成一个超级奇特的布局。也许把注释转移到一个功能设计文档中？只有注释代码不会立即显示所做的事情。不要深入描述在代码注释中所做的事情，请在外部文档中这样做。假设基础知识，然后添加缺少的内容。如果你需要超过10-20个单词，你可能不理解正在做的事情的本质，或者代码太复杂，需要分解成更小的部分。好的，谢谢大家，我会考虑你们的建议。非常感谢，我终于用上了记事本。这个应用程序实际上是一个个人应用程序，但我写它的方式对我来说有点不寻常。这就是为什么我对代码的许多部分进行了评论，以解释它们的重要性、作用和用途。。。这也是因为我打算稍后共享此应用程序。