csharplang/spec/documentation-comments.md

35 строки
4.6 KiB
Markdown
Исходник Обычный вид История

# Documentation comments
This content has moved to the [`dotnet/csharpstandard`](https://github.com/dotnet/csharpstandard) repository.
The list below provides links to each heading in this section. The links specify the C# 6 branch, which is version when the specifications merged.
> To view the text of the Microsoft spec before merging with the ECMA text, checkout the [ms-spec-text](https://github.com/dotnet/csharplang/releases/tag/ms-spec-text) tag in this repository.
- <a id="documentation-comments"></a>[Documentation comments](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#annex-d-documentation-comments)
- <a id="introduction"></a>[Introduction](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d2-introduction)
- <a id="recommended-tags"></a>[Recommended tags](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d3-recommended-tags)
- <a id="<c>"></a>[`<c>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d32-c)
- <a id="<code>"></a>[`<code>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d33-code)
- <a id="<example>"></a>[`<example>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d34-example)
- <a id="<exception>"></a>[`<exception>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d35-exception))
- <a id="<include>"></a>[`<include>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d36-include)
- <a id="<list>"></a>[`<list>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d37-list)
- <a id="<para>"></a>[`<para>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d38-para)
- <a id="<param>"></a>[`<param>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d39-param)
- <a id="<paramref>"></a>[`<paramref>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d310-paramref)
- <a id="<permission>"></a>[`<permission>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d311-permission)
- <a id="<remarks>"></a>[`<remarks>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d312-remarks)
- <a id="<returns>"></a>[`<returns>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d313-returns)
- <a id="<see>"></a>[`<see>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d314-see)
- <a id="<seealso>"></a>[`<seealso>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d315-seealso)
- <a id="<summary>"></a>[`<summary>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d316-summary)
- <a id="<value>"></a>[`<value>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d319-value)
- <a id="<typeparam>"></a>[`<typeparam>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d317-typeparam)
- <a id="<typeparamref>"></a>[`<typeparamref>`](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d318-typeparamref)
- <a id="processing-the-documentation-file"></a>[Processing the documentation file](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d4-processing-the-documentation-file)
- <a id="id-string-format"></a>[ID string format](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d42-id-string-format)
- <a id="id-string-examples"></a>[ID string examples](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d43-id-string-examples)
- <a id="an-example"></a>[An example](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d5-an-example)
- <a id="c#-source-code"></a>[C# source code](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d51-c-source-code)
- <a id="resulting-xml"></a>[Resulting XML](https://github.com/dotnet/csharpstandard/blob/standard-v6/standard/documentation-comments.md#d52-resulting-xml)