如何从<;另请参见>;标签

本文关键字:gt 标签 lt | 更新日期: 2023-09-27 18:27:35

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

然而,我在如何链接到给定类的成员页面上遇到了麻烦。我的意思是说,例如,我有一个名为Class1的类,它具有各种方法和属性。我可以通过<seealso>以以下方式链接到类本身:

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

有没有一种方法可以使用cref属性将我带到显示类的所有成员而不是类本身的页面?我在MSDN上的<see><seealso>或cref页面上都找不到任何文档。

基本上,我在寻找类似以下的东西(显然不起作用):

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

我在这条线上尝试了一些变体,这充其量是对它实际可能是什么的最佳猜测,但我的搜索/尝试并没有被证明很有帮助。这可能吗?

如何从<;另请参见>;标签

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

首先,我确保Sandcastle中的Topic文件命名方法设置为"Member name"
其次,see/seealso标签必须按照以下方式进行格式化:

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

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

target="_self"是在同一帮助文件中打开链接主题所必需的,否则它将在浏览器窗口中打开。