12

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

<see cref="member"/>

最好在这里解释一下。

您如何引用索引器？

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

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

提前致谢。

4

5 回答 5

12 
<see cref="P:System.Collections.ArrayList.Item(System.Int32)" />
于 2008-12-04T16:09:16.757 回答
6 
<see cref="this[int]" />
于 2008-12-04T16:38:59.880 回答
2

我有同样的问题，但有一个通用的Dictionary.Item(TKey) 属性。leppie的回答

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

以及ICR 的附加链接（不幸的是我找不到“mscorlib.xml”）

MSDN：处理 XML 文件（C# 编程指南）

帮了我。

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

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

只产生纯黑色文本，因此只有秒显示标签符号 <> 作为给定的“硬编码”。

我在 MSDN 页面上找到了将反引号 (`) 用于泛型的解决方案，并在我的 XMLDoc 中获得了对类和属性的完整（“彩色”）引用：

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

Dictionary<TKey, TValue>.this[TKey]
于 2016-01-26T12:09:55.700 回答
2 
<see cref="ReadOnlyCollection{T}.this[int]" />

正如这里建议的那样。

于 2017-06-08T09:34:22.103 回答
1

通常，为了了解如何在您的注释中引用任何成员，请在您的 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)"/>
于 2011-06-04T04:08:27.737 回答