【问题标题】:XML Comments -- How (or where) do you create XML comments for your namespaces and library?XML 注释——您如何(或在哪里)为您的命名空间和库创建 XML 注释?
【发布时间】:2011-08-29 05:07:34
【问题描述】:

我了解,如果您 /// 在类、字段、方法或属性之上,Visual Studio 将开始为您建立 XML 样式的 cmets。

但是,我可以去哪里为我的命名空间和/或库添加 XML cmets...

例如:

我不确定这些页面是手动创建的,还是通过在适当位置添加的 XML 样式的 cmets 自动创建的?

【问题讨论】:

标签: .net namespaces assemblies sandcastle xml-comments


【解决方案1】:

要生成 xml 文件,您需要在项目属性中打开它。它是项目属性的Build 选项卡上的复选框XML documentation file

如果您打开它并重新编译程序集,则会在程序集旁边显示一个与该程序集同名的 xml 文件。

然后,您可以使用 sandcastle 之类的工具为您的代码创建帮助文件。 sandcastle 其实是一套工具,可以用来自定义生成帮助文件的全过程。此路径需要大量阅读沙堡帮助文件和教程。

sandcastle 安装的示例文件夹中还有一个工具,可让您快速生成帮助文件,但提供的自定义较少。

过去我曾使用过一段时间的名为“DocProject”的 Visual Studio 插件。我不确定它是否仍然处于活动状态,但如果您有兴趣,可以在 codeplex 上找到它:http://docproject.codeplex.com/

根据 Microsoft 的说法,您引用的 MSDN 示例不是通过从源代码中提取 /// 标记创建的,而是更多地与拆分程序员和文档编制部门有关。

【讨论】:

    【解决方案2】:

    这取决于您用来生成文档的工具。我相信,使用NDoc,您只需在要记录的命名空间内创建一个名为NamespaceDoc 的类。然后将使用该类的 XML-Comment。

    由于问题被标记为“沙堡”,我假设您确实在使用它。如果是这样,this SO answer 应该提供详细信息。

    更新:好的,我刚刚 (in that same thread) 看到 Sandcastle 显然也理解 NamespaceDoc-classes。有人可能希望将此问题作为重复项关闭。

    【讨论】:

    • 我对这个用于命名空间的 XML-Comment 有疑问,我们是否需要为整个项目中的每个类创建 NamespaceDoc 类?还是我错过了什么?我没有使用“沙堡”
    • 您为项目(您想要记录的)中的每个命名空间(和内部)创建一个“NamespaceDoc”类。
    猜你喜欢
    • 1970-01-01
    • 2011-08-25
    • 2012-06-06
    • 2011-01-16
    • 2018-11-29
    • 1970-01-01
    • 2011-10-09
    • 2015-09-19
    • 1970-01-01
    相关资源
    最近更新 更多