熱點推薦:
您现在的位置: 電腦知識網 >> 編程 >> .NET編程 >> 正文

在C#使用XML注釋

2013-11-13 10:10:16  來源: .NET編程 

  簡介

  大多數程序員可能都聽說過Java自帶的一個工具JavaDoc使用它可以自動地為你的代碼生成HTML文檔C#和C#編譯器也有類似的功能不過它生成的是XML而不是直接生成HTML不過使用XML會使得文檔更加靈活

  注釋語法

  為了使用C#提供的XML注釋功能你的注釋應該使用特殊的注釋語法(///)開頭在///之後你可以使用預先定義的標簽注釋你的代碼也可以插入你自己定義的標簽你定制的標簽將會在隨後加入到生成的注釋文檔中

  預定義的標簽            用處

  <c>                             將說明中的文本標記為代碼

  <code>                       提供了一種將多行指示為代碼的方法

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

  <exception>         允許你指定可能發生的異常類

  <include>                           允許你引用描述源代碼中類型和成員的另一文件中的注釋 使用 XML XPath 語法來描述你的源代碼中的類型和成員

  <list>                           向XML注釋文檔中插入一個列表

  <para>                        向XML注釋文檔中插入一個段落

  <param>                     描述一個參數

  <paramref>                 提供了一種指示一個詞為參數的方法

  <permission>              允許你將成員的訪問許可加入到文檔中

  <remarks>                  用於添加有關某個類型的信息

  <returns>                    描述返回值

  <see>                         指定鏈接

  <seealso>                   指定希望在請參見一節中出現的文本

  <summary>                 類型或類型成員的通用描述

  <value>                描述屬性

  例子

  下面的例子為我們常見的HelloWorld控制台應用程序添加注釋

  using System;

  namespace HelloWorld
{
    /// <summary>
    /// Sample Hello World in C#
    /// </summary>
    public class HelloWorld
    {
        /// <summary>
        /// Console Application Entry Point
        /// <param name=args>Command Line Arguments</param>
        /// <returns>Status code of on successful run</returns>
        /// </summary>
        public static int Main(string[] args)
        {
            SystemConsoleWriteLine(HelloWorld);
            string name = SystemConsoleReadLine();

  return();
        }
    }
}

  為生成XML注釋文檔我們在調用csc編譯源代碼時使用/doc選項

  csc /doc:HelloWorldxml helloworldcs

  生成的結果文檔如下

  <?xml version=?>

  <doc>

  <assembly>

  <name>XMlComment</name>

  </assembly>

  <members>

  <member name=T:HelloWorldHelloWorld>

  <summary>

  Sample Hello World in C#

  </summary>

  </member>

  <member name=M:HelloWorldHelloWorldMain(SystemString[])>

  <summary>

  Console Application Entry Point

  <param name=args>Command Line Arguments</param>

  <returns>Status code of on successful run</returns>

  </summary>

  </member>

  </members>

  </doc>

  HTML頁面

  你可能會問自己我應該如何才能得到具有良好格式的HTML頁面呢?很簡單你可以編寫自己的XSL來轉換生成的XML注釋文檔或者使用Visual StudioNET開發工具通過使用VSNET的【工具】菜單中的【生成注釋web頁】你可以得到一系列詳細說明你的項目或解決方案的HTML頁面下面就是通過VSNET生成的注釋helloWorld程序的HTML頁面快照

  


From:http://tw.wingwit.com/Article/program/net/201311/12777.html
    Copyright © 2005-2013 電腦知識網 Computer Knowledge   All rights reserved.