点点滴滴


         从点开始绘制自己的程序人生
  博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

在C#使用XML注释

Posted on 2006-12-16 16:21  点点滴滴  阅读(348)  评论(0编辑  收藏  举报
预定义的标签            用处

<c>                             将说明中的文本标记为代码

<code>                       提供了一种将多行指示为代码的方法

<example>                  指定使用方法或其他库成员的示例

<exception>         允许你指定可能发生的异常类

<include>                           允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。

<list>                           向XML注释文档中插入一个列表

<para>                        向XML注释文档中插入一个段落

<param>                     描述一个参数

<paramref>                 提供了一种指示一个词为参数的方法

<permission>              允许你将成员的访问许可加入到文档中

<remarks>                  用于添加有关某个类型的信息

<returns>                    描述返回值

<see>                         指定链接

<seealso>                   指定希望在“请参见”一节中出现的文本

<summary>                 类型或类型成员的通用描述

<value>                描述属性