XML文档注释

XML文档注释

C# XML注释，

即我们在某个函数前新起一行，输入///，VS.Net会自动增加XML格式的注释

编译器识别的标记

标记	说明
<C>	把行中的文本标记为代码，例如<c>int i=10;</c>
<code>	把多行标记为代码
<example>	标记为代码示例
<exception>	说明一个异常类
<include>	包含其他文档说明文件的注释
<list>	把列表插入文档中
<para>	建立文本的结构
<param>	标记方法的参数
<paramref>	表明一个单词是方法的参数
<permission>	说明对成员的访问
<remarks>	给成员添加描述
<returns>	说明方法的返回值
<see>	提供对另一参数的交叉引用
<seealso>	提供描述中的参见部分
<summary>	提供类型或成员的简短描述
<typeparam>	用在泛型类型的注释中，以说明一个类型参数
<typepararef>	类型参数的名称
<value>	描述属性

添加XLM注释的方法

在要注释内容的上一行点击三次“/”(要在英文输入的模式下)编译器会自动添加注释内容，如果还是添加不上，在vs下点击工具->选项->文本编辑器->C#->高级->(勾选)为///生成XLM文档注释

        //  <summary>对 类  属性 字段 方法... 功能的描述
        //  <param> 对参数的描述
        //  <returns> 对返回值的描述
        /// <summary>
        ///  从后向前查询参数在源字符串首次出现的索引的位置
        /// </summary>
        /// <param name="beseString">被查询的源字符串</param>
        /// <param name="value">查询的字符串</param>
        /// <returns>如果存在 返回索引 不存在,返回-1</returns>

示例

 //  <summary>对 类  属性 字段 方法... 功能的描述
        //  <param> 对参数的描述
        //  <returns> 对返回值的描述
        /// <summary>
        ///  从后向前查询参数在源字符串首次出现的索引的位置
        /// </summary>
        /// <param name="beseString">被查询的源字符串</param>
        /// <param name="value">查询的字符串</param>
        /// <returns>如果存在 返回索引 不存在,返回-1</returns>
        static public int LastIndexOf(string beseString, string value)
        {

            int len = value.Length;
            for (int i = beseString.Length - len; i >= 0; i--)
            {
                string s = "";
                for (int j = i; j <= i + len - 1; j++)
                {
                    s += beseString[j];
                }
                if (s == value)
                {
                    return i;
                }

            }
            return -1;
        }