如何在C#XML注释中链接/分组重载？

Question

在XML文档中对C#的注释中,有没有办法将两个或多个函数标记为彼此重载,以便它们自动引用？理想情况下,它们也会以某种方式分组在沙堡生成的文档中.

目的:通常,我想链接到这组功能,例如在效用函数列表中,只提一个重载,并使其他功能很容易从那里发现.

目前我正在添加链接,但这很乏味.

Answer 1

XMl 文档和 Sandcastle 已识别并分组了多个重载之间的关系。

使用see或seealso标签创建到其他成员的链接。

例如。

///See <see cref="M:AnotherMethod(System.String)">

我发现 Sandcastle 成员解析可能有点不稳定，所以我倾向于使用完全限定名称。

///See <see cref="M:MyCompany.Myapp.MyClass.AnotherMethod(System.String)">

请注意，M: 表示正在引用成员，您还可以使用 E: 来指向事件。T：用于类型，但如果不存在则假定为类型。