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>