在C#中,可以使用特殊的注釋格式編寫XML文檔注釋,以便生成XML文檔。XML文檔注釋以三個斜杠“///”開始,后面可以跟著一段描述性的注釋內容,例如:
/// <summary>
/// This method adds two numbers together and returns the result.
/// </summary>
/// <param name="num1">The first number to be added</param>
/// <param name="num2">The second number to be added</param>
/// <returns>The sum of the two numbers</returns>
public int AddNumbers(int num1, int num2)
{
return num1 + num2;
}
在上面的例子中,<summary>
標簽用于提供方法的概要描述,<param>
標簽用于描述方法的參數,<returns>
標簽用于描述方法的返回值。這些注釋將被編譯器提取并生成XML文檔文件,以便其他開發人員可以通過IDE或者文檔工具查看這些注釋信息。
要生成XML文檔文件,可以在項目屬性的“生成”選項卡中啟用“XML 文檔文件”選項,然后編譯項目。生成的XML文檔文件將與生成的程序集一起保存在輸出目錄中。