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

Question

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

目的：通常，我想链接到这组函数，例如在实用函数列表中，只需提及其中一个重载，并让其他重载从那里很容易被发现。

目前我正在添加链接，但这很乏味。

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: 用于类型，但如果不存在则假定为。

Answer 2

分组是由 Sandcastle 自动完成的，对，但是如果你想给重载组一个通用的描述，请使用 <overloads> 标记（与 <summary> 相同）。它不是一个标准的 XML 文档标签，但是 Sandcastle Help File Builder 支持它。