将XML注释移出源代码

Question

是否有一个工具可以在代码库中提取我的XML注释并将它们放在XML文件中？我不想自己维护一个单独的文件，我想在完成后生成XML并从源代码中删除内容。

Answer 1

您要求的方法的问题是，一旦您更改代码，您的“预编译的xml”将与它不同步（或者如果您想要停止此hapening，您将必须编辑手工编写xml文件，这比看到原始XML注释要差一千倍！）。我认为你真的应该考虑接受文档评论并充分利用使用它们带来的诸多好处（直接和间接）。但是如果你想这样做，你只需要启用XML文档输出的生成，重建项目，然后从bin \ debug或bin \ release文件夹中复制出XML文件，然后开始削减和刻录。

然而，还有其他一些破坏性较小的选择：

• 您可以在工具＆gt;中更改文档注释的语法着色颜色。选项：环境＆gt;字体和颜色。使用微弱的颜色，注释将淡入背景。

• 也许如果评论更整洁，他们就不会让你的眼睛流血。我编写了一个插件（Atomineer Pro Documentation），可以将全面的格式选项应用于文档注释，使其更易于查看：上/下注释的可选分隔符，条目内和周围的可选空格，可选列文本块的对齐，可选的自动换行等。或者，如果XML标签真正受到伤害，它可以将您的注释转换为不那么刺耳的格式（它支持Doxygen，JavaDoc和Qt以及XML文档）。

• 我的插件还有一个选项，可以使用VS中的“概述”工具隐藏文档注释（按需或打开文档时）。它可以通过隐藏文档注释来缓解您的一些症状。

• 从理论上讲，可以编写一个VS2010扩展，可以更改doc注释的显示以删除标记并显示更多所见即所得。我没有听说过任何东西，但现在可能会有一些东西可以帮助你。

Answer 2

您可以将Visual Studio编译器与/doc开关一起使用。此选项也可在Build选项卡上的项目属性中使用，并命名为XML documentation file。它会生成带有注释的单独XML文件，然后IntelliSense可以使用这些注释。如果您要使用使用注释（实用程序库）分发已编译的程序集，则可以使用它。还有一种叫Sandcastle的东西。查看this link

您可能还要查看NDoc。它将根据您的XML注释生成代码文档。它是开源的。

如果您正在更多地了解如何让评论更少分散注意力，那么将其颜色更改为更苍白的东西会有所帮助（工具 - ＆gt;选项 - ＆gt;环境 - ＆gt;字体和颜色）。您还可以使用macro 折叠所有评论。

无论如何，我建议在您的代码中留下评论 - 它使代码更多更易于维护。