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

时间:2008-12-26 11:45:04

标签: c# overloading sandcastle xml-comments

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

目的:通常,我想链接到这组功能,例如在实用程序函数列表中,只需提及其中一个重载,并从其中轻松发现其他函数。

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

2 个答案:

答案 0 :(得分:2)

已经识别出多个重载之间的关系,并通过XMl文档和Sandcastle进行分组。

使用seeseealso标记创建指向其他成员的链接。

例如

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

我发现虽然Sandcastle会员的解决方案有点不稳定所以我倾向于使用完全合格的名字。

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

注意M:表示正在引用成员,您还使用E:指向事件。 T:用于类型,但如果不存在则假设。

答案 1 :(得分:1)

分组由Sandcastle自动完成,但如果您想为重载组提供一个通用描述,请使用&lt; overloads&gt;标记(与&lt; summary&gt;相同)。 它不是标准的XML文档标记,但是Sandcastle帮助文件生成器支持AFAIR。