c#中有关Xml注释的使用和生成

有关XML注释的详细讲解见:http://msdn.microsoft.com/zh-cn/library/b2s063f7(VS.80).aspx

                                   http://wenku.baidu.com/view/ca7372ddd15abe23482f4dfd.html

                                   http://apps.hi.baidu.com/share/detail/763691

XML注释可以使得代码可读性增强，并且可以使得成员类型具有自动提示功能

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace xmldoc
{
    /// <summary>
    /// 这是person类的声明
    /// </summary>
    class person
    {
        /// <summary>
        /// 用户的姓名
        /// </summary>
        private string name;

        /// <summary>
        /// Name属性
        /// </summary>
        /// <value>用于描述用户的姓名</value>
        public string Name
        {
            get 
            {
                if (name == null)
                {
                    throw new Exception("姓名为空");
                }
                else
                {
                    return name;
                }
            }
            set
            {
                name = value;
            }
        }

        /// <summary>
        /// person类的构造函数
        /// </summary>
        /// <param name="name">传入用户的参数名作为参数</param>
        /// <seealso cref="string">利用cref来引用描述成员</seealso>
        public person(string name)
        {
            this.Name = name;
        }
    }

    /// <summary>
    /// 主程序的执行类
    /// </summary>
    class Program
    {
        /// <summary>
        /// 应用程序入口
        /// </summary>
        /// <param name="args">命令行参数列表</param>
        static void Main(string[] args)
        {
            person myperson = new person("fox");
            Console.WriteLine(myperson.Name);
        }
    }
}

这里的注释方法是在每一个代码模块上用///开始注释，如需添加额外注释信息，可以通过回车后添加，如下图

 

标注完成后通过项目的属性面板中的生成选项导出xml文件

勾选xml文档文件，F6生成解决方案后，即可在输出路径下找到对应文件

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>xmldoc</name>
    </assembly>
    <members>
        <member name="T:xmldoc.person">
            <summary>
            这是person类的声明
            </summary>
        </member>
        <member name="F:xmldoc.person.name">
            <summary>
            用户的姓名
            </summary>
        </member>
        <member name="M:xmldoc.person.#ctor(System.String)">
            <summary>
            person类的构造函数
            </summary>
            <param name="name">传入用户的参数名作为参数</param>
            <seealso cref="T:System.String">利用cref来引用描述成员</seealso>
        </member>
        <member name="P:xmldoc.person.Name">
            <summary>
            Name属性
            </summary>
            <value>用于描述用户的姓名</value>
        </member>
        <member name="T:xmldoc.Program">
            <summary>
            主程序的执行类
            </summary>
        </member>
        <member name="M:xmldoc.Program.Main(System.String[])">
            <summary>
            应用程序入口
            </summary>
            <param name="args">命令行参数列表</param>
        </member>
    </members>
</doc>

转载于:https://www.cnblogs.com/madkex/archive/2012/05/25/2518696.html