zoukankan      html  css  js  c++  java
  • C# XML 文档注释

    <summary>description</summary>
          描述类型或类型成员。
          description:对象的摘要。

    <remarks>description</remarks>
          添加有关某个类型的信息,从而补充由 <summary> 所指定的信息。
          description:成员的说明。

    <example>description</example>
          使用方法或其他库成员的示例。这通常涉及使用 <code> 标记。
          description:代码示例的说明。

    <seealso cref="member"/>
          指定希望在“请参见”一节中出现的文本。
          member:对可以通过当前编译环境进行调用的成员或字段的引用。必须将 member 括在双引号 (" ") 中。

    <typeparam name="name">description</typeparam>
          描述泛型类型或方法的单个类型参数。
          name:类型参数的名称。将此名称用双引号括起来 (" ")。
          description:类型参数的说明。

    <param name="name">description</param>
         描述方法的单个参数。
         name:方法参数名。将此名称用双引号括起来 (" ")。
         description:参数说明。

    <returns>description</returns>
         描述方法的返回值。
         description:返回值的说明。

    <value>property-description</value>
         描述属性所代表的值。
         property-description:属性的说明。
    <permission cref="member">description</permission>
        成员的访问权限。使用 PermissionSet 类可以指定对成员的访问。
        member:对可从当前编译环境中获取的权限的引用。必须将 member 括在双引号 (" ") 中。
        description:对成员的访问的说明。

    <exception cref="member">description</exception>
         指定哪些异常可能被引发。此标记可用在方法、属性、事件和索引器的定义中。
         member:对可从当前编译环境中获取的异常的引用。必须将 member 括在双引号 (" ") 中。
         description:异常的说明。
    <c>text</c>
         将说明中的文本标记为代码。
         text:希望将其指示为代码的文本。

    <code>content</code>
         将多行文本指示为代码。
         content:希望将其指示为代码的文本。
    <see cref="member"/>
         从文本内指定链接。
         member:对可以通过当前编译环境进行调用的成员或字段的引用。应将 member 放在双引号 (" ") 中。
    <paramref name="name"/>、<typeparamref name="name"/>
         分别引用某个参数或某个类型参数。
         member:要引用的参数名(类型参数的名称)。将此名称用双引号括起来 (" ")。

    <para>content</para>
          用于诸如 <summary>、<remarks> 或 <returns> 等标记内,使您得以将段落添加到文本中。
          content:段落文本。

    <list type="bullet" | "number" | "table">
       <listheader>
            <term>term</term>
            <description>description</description>
        </listheader>
        <item>
            <term>term</term>
            <description>description</description>
        </item>
    </list>

          <listheader> 块用于定义表或定义列表中的标题行。定义表时,只需为标题中的项提供一个项。
          列表中的每一项都用一个 <item> 块来描述。创建定义列表时,既需要指定 term 也需要指定 description。但是,对于表、项目符号列表或编号列表,只需为 description 提供一个项。
          列表或表所拥有的 <item> 块数可以根据需要而定。
          term:要定义的项,该项将在 description 中定义。
          description:项目符号列表或编号列表中的项或者 term 的定义。

  • 相关阅读:
    【转】数据库分页Java实现
    【转】ibatis的简介与初步搭建应用
    response.setContentType()的作用及参数
    【转】mysql数据库中实现内连接、左连接、右连接
    【转】JAVA的StringBuffer类
    【转】Java学习之Iterator(迭代器)的一般用法 (转)
    函数装饰器
    闭包函数
    函数(2)
    函数(1)
  • 原文地址:https://www.cnblogs.com/shijun/p/3006352.html
Copyright © 2011-2022 走看看