C# XML 文件註解完整指南：標籤、編譯與文件產生

XML 註解優勢

C# 編譯器支援 XML 文件註解，輸出結構化 XML 而非直接產生 HTML，提供更高彈性，可搭配 XSLT 轉換為各種格式。

註解語法與標準標籤

使用 /// 開頭，支援預定義與自訂標籤：

實作範例

using System;
namespace HelloWorld {
    /// <summary>
    /// Sample Hello World in C#
    /// </summary>
    public class HelloWorld {
        /// <summary>
        /// Console Application Entry Point
        /// </summary>
        /// <param name="args">Command Line Arguments</param>
        /// <returns>Status code of 0 on successful run</returns>
        public static int Main(string[] args) {
            System.Console.WriteLine("HelloWorld");
            string name = System.Console.ReadLine();
            return 0;
        }
    }
}

編譯產生 XML 文件

csc /doc:HelloWorld.XML helloworld.cs

產生結構化 XML，包含組件名稱與成員資訊：

<?xml version="1.0"?>
<doc>
  <assembly><name>XMLComment</name></assembly>
  <members>
    <member name="T:HelloWorld.HelloWorld"><summary>Sample Hello World in C#</summary></member>
    <member name="M:HelloWorld.HelloWorld.Main(System.String[])">
      <summary>Console Application Entry Point</summary>
      <param name="args">Command Line Arguments</param>
      <returns>Status code of 0 on successful run</returns>
    </member>
  </members>
</doc>

產生 HTML 文件

可編寫 XSLT 樣式表轉換，或使用 Visual Studio 工具 → 產生註解網頁 功能快速產生格式化 HTML 文件。