后端学习记录 2

C#.NET 注释参考网址 https://learn.microsoft.com/zh-cn/dotnet/csharp/language-reference/xmldoc/

“
通过编写由三斜杠指示的特殊注释字段，可以为代码创建文档。
注释字段包含用于描述注释后面的代码块的 XML 元素。
”

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass {}

“当输入MyClass时会在鼠标停留处显示注释文档，显示在对象浏览窗口”

// 常规标记
<summary>用于描述</summary>
<remarks>用于添加</remarks>

// 成员记录
<returns>描述返回值</returns>
<param name="name">描述方法参数</param>
<paramref name="引用参数"/>
<exception cref="member">可引发的异常</exception>
<value>描述属性表示的值</value>

// 文档输出格式
<remarks>
    <para>双空格段落</para>
    <para>...</para>
</remarks>

<list type="bullet|number|table">
    <listheader>
        <term>列表标题行的条目</term>
        <description>必有</description>
    </listheader>
    <item>
        <term>列表中单个项</term>
        <description>必有</description>
    </item>
</list>

<example>
和c、code配合使用，用于举出使用示例
<c>单行代码</c>
<code>
    多行代码
</code>
</example>

// 重用文档
<inheritdoc [cref="要继承文档的成员"] [path="用于XPath表达式查询"]/>继承其他地方的注释
<include file='含文档的XML文档名称' path='指向标记name的路径[@name="id"]' />

// 超链接
<see cref="member"/>
<see cref="member">连接说明</see>
<see href="可单击链接">连接说明</see>
<see langword="keyword"/>

// 泛型类型和方法
<typeparam name="类型参数名称">描述，可显示在IntelliSense</typeparam>
<typeparamref name="类型参数名称，可设置字体格式"/>