如何从 <seealso> 标签引用会员页面?
How can I reference a Members page from a <seealso> tag?
我正在生成一些 XML 文档,然后通过 Sandcastle 将其构建到帮助文件 (.chm) 中。
但是,我被绊倒了如何 link 到给定 class 的会员页面。我的意思是说,例如,我有一个名为 Class1
的 class,具有各种方法和属性。我可以按以下方式通过 <seealso>
link 到 class 本身:
/// <seealso cref="Class1">Class1</seealso>
有没有办法使用 cref 属性将我带到显示 class 所有成员的页面,而不是 class 本身?我没有在 MSDN 上的 <see>
、<seealso>
或 cref 页面上找到任何文档。
基本上,我一直在寻找类似以下内容的内容(显然行不通):
/// <seealso cref="Class1.Members">Class1 Members</seealso>
我已经尝试了该行的一些变体,充其量只是对它实际可能是什么的最好猜测,但我的 searches/tries 并没有被证明很有帮助。这可能吗?
经过更多挖掘,我找到了我要找的东西:
首先,我确定Sandcastle中的Topic文件命名方式设置为"Member name"。
其次,see/seealso 标签必须按以下方式格式化:
/// <seealso href="AllMembers_T_MyNamespace_Class1.htm" target="_self">Class1 Members</seealso>
href 属性的名称可以通过右键单击所需页面并在页面的 "Properties" 中查看来找到。
要在同一帮助文件中打开链接主题,需要 target="_self"
,否则它会在浏览器中打开 window。
我正在生成一些 XML 文档,然后通过 Sandcastle 将其构建到帮助文件 (.chm) 中。
但是,我被绊倒了如何 link 到给定 class 的会员页面。我的意思是说,例如,我有一个名为 Class1
的 class,具有各种方法和属性。我可以按以下方式通过 <seealso>
link 到 class 本身:
/// <seealso cref="Class1">Class1</seealso>
有没有办法使用 cref 属性将我带到显示 class 所有成员的页面,而不是 class 本身?我没有在 MSDN 上的 <see>
、<seealso>
或 cref 页面上找到任何文档。
基本上,我一直在寻找类似以下内容的内容(显然行不通):
/// <seealso cref="Class1.Members">Class1 Members</seealso>
我已经尝试了该行的一些变体,充其量只是对它实际可能是什么的最好猜测,但我的 searches/tries 并没有被证明很有帮助。这可能吗?
经过更多挖掘,我找到了我要找的东西:
首先,我确定Sandcastle中的Topic文件命名方式设置为"Member name"。
其次,see/seealso 标签必须按以下方式格式化:
/// <seealso href="AllMembers_T_MyNamespace_Class1.htm" target="_self">Class1 Members</seealso>
href 属性的名称可以通过右键单击所需页面并在页面的 "Properties" 中查看来找到。
要在同一帮助文件中打开链接主题,需要 target="_self"
,否则它会在浏览器中打开 window。