Question

为了在XML注释/文档中引用类的成员，您必须使用以下标记：

<see cref="member"/>

更好地解释here。

如何引用索引器？

我的意思是，像这样的成员：

internal object this[ int index ] {
    ...
}

提前致谢。

Answer 1

<see cref="P:System.Collections.ArrayList.Item(System.Int32)" />

Answer 2

<see cref="this[int]" />

Answer 3

通常，为了找出如何引用注释中的任何成员，请在XML文档文件中找到该程序集的成员。它是在每个构建上创建的。除了泛型之外，成员参考可以从这里获取：

</member>
<member name="P:My.Namespace.Class1.Item(System.String)">
    <summary>
       retrieve a single item of the given name from this instance
    </summary>
    <param name="name">name of the item</param>
    <returns>the item</returns>
</member>
<member name="M:My.Namespace.Class1.Function1(System.Int32[])">
    <summary> 
    ...

不幸的是，通用定义格式似乎在文档文件和cref标签之间不兼容。在XML文件中，泛型看起来像这样：

<member name="M:My.Namespace.Class1.Get``1(System.String)">
    <summary>
    retrieve an named item of the given type
    </summary>
    <typeparam name="T">the type of the item to retrieve</typeparam>
    ...

cref标记需要采用以下格式之一：

/// <seealso cref="M:My.Namespace.Class1.Get{T}(System.String)"/>   

/// <seealso cref="M:My.Namespace.Class1.Get&lt;T>(System.String)"/>

Answer 4

我有同样的问题，但有一个泛型 Dictionary.Item（TKey）属性。 answer by leppie

<see cref="P:System.Collections.ArrayList.Item(System.Int32)" />

和additional link by ICR（遗憾的是我找不到“mscorlib.xml”）

MSDN: Processing the XML File (C# Programming Guide)

帮助了我。

但是the answer by user492238
（我知道，我应该直接评论他的答案。但由于我是新人，这是我的第一篇文章，请放轻松，因为我的声誉很低，因此我不能发表评论。）

<seealso cref="M:My.Namespace.Class1.Get{T}(System.String)"/>
<seealso cref="M:My.Namespace.Class1.Get<T>(System.String)"/>

仅产生纯黑色文本，其中只有秒显示标记符号＆lt;＆gt;如“硬编码”。

我在MSDN页面上找到了使用反引号（`）进行泛型的解决方案，并在我的XMLDoc中获得了对类和属性的完整（“colory”）引用：

    <see cref="P:System.Collections.Generic.Dictionary`2.Item(`0)" />

Dictionary<TKey, TValue>.this[TKey]

Answer 5

<see cref="ReadOnlyCollection{T}.this[int]" />

提议here。

如何在C＃注释中引用类的索引器成员

5 个答案: