C# 文件註解的 XML 標記

說明

我會使用文件式的註解主要是因為 Visual Studio 之類的工具會為文件註解中使用的許多常見 XML 元素提供 IntelliSense，當然還有統一的註解規範等等的好處，本篇將紀錄一些我比較常用的註解技巧筆記。

br

如果你想換行，使用 <br/> 即可。

/// <summary>
/// 使用速度左右移動
/// </summary>
/// <param name="direction">
/// 移動方向<br/>
/// -1 向左<br/>
/// 0 靜止<br/>
/// 1 向右
/// </param>
public void MoveByDirection(float direction)
{
    // 略
}

param

param 就是參數的意思，用來描述參數

/// <summary>
/// 使用位移差左右移動
/// </summary>
/// <param name="delta">位移差</param>
public void MoveByDelta(float delta)
{
    // 略
}

summary

在 Visual Studio Code 中，在方法或成員等等的正上方打 /// 就會跳出一段 /// <summary> 標籤的註解，用來描述功能、型態等等的資訊。

/// <summary>
/// 使用位移差左右移動
/// </summary>
/// <param name="delta">位移差</param>
public void MoveByDelta(float delta)
{
    // 略
}

參考

• 建議用於 C# 文件註解的 XML 標記