如何从<seealso>标签引用“成员”页面?

时间:2015-12-21 20:34:14

标签: c# xml sandcastle

我正在生成一些XML文档,我将通过Sandcastle构建一个帮助文件(.chm)。

然而,我被绊倒了如何链接到给定班级的会员页面。我的意思是说,例如,我有一个名为Class1的类,有各种方法和属性。我可以通过以下方式通过<seealso>链接到班级本身:

/// <seealso cref="Class1">Class1</seealso>

有没有办法使用cref属性代替我带到显示该类所有成员的页面,而不是类本身?我没有在MSDN上的<see><seealso>或cref页面上找到任何文档。

基本上,我一直在寻找以下内容(显然不能正常工作):

/// <seealso cref="Class1.Members">Class1 Members</seealso>

我在这一行上尝试了一些变体,最多只能猜测它实际上是什么,但我的搜索/尝试都没有被证明非常有用。这甚至可能吗?

1 个答案:

答案 0 :(得分:1)

经过一番挖掘,我找到了我想要的东西:

首先,我确保Sandcastle中的Topic文件命名方法设置为“成员名称” 其次,see / seealso标签必须按以下方式格式化:

/// <seealso href="AllMembers_T_MyNamespace_Class1.htm" target="_self">Class1 Members</seealso>  

通过右键单击所需页面并在页面的“属性”中查看,可以找到href属性的名称。

链接主题需要target="_self"才能在同一帮助文件中打开,否则会在浏览器窗口中打开。