当前位置:  开发笔记 > 编程语言 > 正文

如何在C#中的<seealso>标记中创建一个cref to方法重载?

如何解决《如何在C#中的<seealso>标记中创建一个crefto方法重载?》经验,为你挑选了3个好方法。

我在MSDN链接中看到诸如"CompareOrdinal Overloads".如何在C#中编写这样的链接?

我试过了:

MyMethod Overloads

但编译器给出了一个警告,即对于具有其他重载的方法是一个模糊的引用.

(初学者问题:我是否真的需要编写此标记来链接到重载,还是由文档处理器自动生成?)



1> Marc Gravell..:

针对特定成员,我相信您只需匹配签名:

/// 
static void Foo() { }
/// 
///  <------ complains
static void Foo(int a) { }

说实话,我不确定如何生成"所有重载"链接; 我假设任何合理的发电机都会自动完成.



2> Wilhelm..:

使用Sandcastle很简单:

MyMethod Overloads

FullyQualifiedMyMethod是达到重载所需的完整路由,包括名称空间和类,即:System.Linq.Enumerable.Sum

但是,VB编译器会发出一条警告,说明该属性无法解析,可以忽略.


使用SHFB 2014.5.31.0进行测试表明前缀必须是`o:`,而不是`overloads:`.

3> AnthonyWJone..:

Xml文档没有引用方法的所有重载的方法。

用于C#项目的最受欢迎的文档生成器是Sandcastle。如有必要,它将自动创建一个指向过载列表页面的链接。因此,在成员列表页面中,重载方法的名称将仅出现一次,单击该名称将导航至该方法的重载页面列表,并从该页面跳转至特定的重载。

在Xml文档中放置指向过载列表页面的链接可能需要对所使用的外部工具有深入的了解,并且可能不是一个好主意。

如果您确实必须具有此功能,那么也许一种方法是使用具有特定格式ID的锚。大多数文档生成器都提供了一些神秘的方法来对生成的文件进行预处理或后处理,并应使您有机会挑选出这些锚点并为其提供适当的href。

呵呵,这可能比它的价值还要麻烦;)

推荐阅读
mobiledu2402852413
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有