【问题标题】:Include common content from xml documentation file包含来自 xml 文档文件的常见内容
【发布时间】:2012-11-12 17:04:44
【问题描述】:

我正在使用 Sandcastle 为项目生成文档。为了引用xml文档文件include标签被使用。

///<include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public class Test

我想从这个 XML 文档文件中引用一些常见的内容。例如:

<MyDocs><MyMembers name="test">
        <summary>
           <include file='common.xml' path='MyDocs/MyMembers[@name="test"]/*' />
        </summary>
</MyMembers></MyDocs>

显然它不能以这种方式工作。做这些事情的正确方法是什么? Sandcastle 可能有一些扩展?

【问题讨论】:

  • 您是否试图从另一个包含的 XML 文件中包含一个 XML 文件?在您的示例中,在我看来,第一个包含添加了第二个文件,并且您希望从那里包含“common.xml”。是这样吗?
  • 我已经使用 Visual Studio 2012 进行了测试,它确实解决了包含文件中的包含问题,因此对我来说它可以按预期工作。当你这样做时,你会得到什么结果?
  • @JorgePoveda,我得到了与总结完全相同的包含标签。你能举出你的例子吗?

标签: sandcastle xml-documentation


【解决方案1】:

通过使用 MAML 令牌文件解决了该问题。 Sandcastle 可以毫无问题地解决它们。

/// <summary>
/// <token>Token1</token>
/// </summary>

【讨论】:

    猜你喜欢
    • 2021-03-13
    • 1970-01-01
    • 2022-11-11
    • 1970-01-01
    • 2021-08-31
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多