1

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

4

2 回答 2

3

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

但是，还有其他破坏性较小的选择：

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

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

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

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

于 2012-04-18T21:59:39.800 回答
1

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

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

如果您正在研究如何使评论不那么分散注意力，那么将它们的颜色更改为更淡的颜色会很有帮助（工具 -> 选项 -> 环境 -> 字体和颜色）。您还可以使用宏来折叠所有评论。

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

于 2012-04-18T21:54:29.980 回答