本文介绍了如何使一个℃的CREF为方法重载; seealso>在C#标签?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我MSDN链接,如CompareOrdinal重载看到的。 ?我怎么能写在C#这样的链接

I see in MSDN links such as "CompareOrdinal Overloads". How can I write such a link in C#?

我试过:

<seealso cref="MyMethod">MyMethod Overloads</seealso>



但是,编译器给我一个警告,关于是对于具有其他重载方法不明确的引用。

But the compiler gives me a warning about being an ambiguous reference for the method which has other overloads.

(初级的问题:我是不是真的需要写这个标签链接到重载,抑或是自动文档处理器生成)

(Beginner question: do I actually need to write this tag to link to the overloads, or is it automatically generated by documentation processors?)

推荐答案

XML文档不必引用的方法的所有重载的方法。

Xml documentation doesn't have a means to reference all overloads of a method.

最C#项目流行的文档生成的沙堡。如果需要,它会自动创建一个链接到重载列表页面。因此,在成员列表页面重载方法的名字只出现一次,单击它会导航你重载页面为方法,并从那里到一个特定的过载列表中。

The most popular documentation generator for C# projects is Sandcastle. It will automatically create a link to an overloads list page if necessary. Hence in a members list page the name of an overloaded method will appear only once, clicking it will navigate you to the list of overloads page for that method and from there to a specific overload.

放置一个链接到XML文档中的重载列表页面将需要外部工具的深入了解所用,可能不是一个好主意。

Placing a link to the overloads list page in Xml documentation would require intimate knowledge of the external tool being used and probably not a good idea.

如果你真的必须具有这然后可能的一种方法是使用一个锚与specificaly形成标识。大多数文档生成器提供的前或后生成的处理文件的一些神秘的手段,应该给你机会选择这些锚并为他们提供适当的HREF。

If you really must have this then perhaps one way is to use an anchor with a specificaly formed ID. Most document generators provide some arcane means of pre or post processing generated files and should give you the opportunity to pick these anchors out and provide an appropriate href for them.

OTH,它可能是更多的麻烦比它的价值;)

OTH, it may be more trouble than its worth ;)

这篇关于如何使一个℃的CREF为方法重载; seealso&GT;在C#标签?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持!

10-29 23:19