C＃方法參數XML的文檔問題

Question

假設，我有一個方法，它的參數是與已經定義文檔類：

/// <summary> 
///  Get criterion from table. 
/// </summary> 
/// <param name="plySide"></param> 
/// <param name="criterionType"></param> 
/// <returns></returns> 
public Criterion GetCriterion(PlySide plySide, CriterionType criterionType) 
{ 
    // some code 
} 

PlySide類有它自己的XML的文檔：

/// <summary> 
///  Sides of monoply. 
/// </summary> 
public enum PlySide 
{ 
    // some code 
} 

正如你可以在GetCriterion方法中看到，我沒有爲plySide param標籤定義任何文檔。 我的問題是我應該重複一個參數的描述還是應該刪除param標記？

Answer 1

的PlySide文檔將描述的類型是什麼。

plySide文檔應描述在GetCriterion方法中該參數在中扮演什麼角色。

這些通常會微妙地（或不那麼微妙）不同。

Answer 2

您不應該複製它，而是給出參數的上下文感知描述。你的情況可能是這樣的（也許是toally錯了，但我不知道你的方法的實施和意向）：

/// <summary> 
///  Get criterion from table. 
/// </summary> 
/// <param name="plySide">Monopoly side to get criterion for</param> 
/// <param name="criterionType">Criterion to get for the given monopoly side</param> 
/// <returns></returns> 
public Criterion GetCriterion(PlySide plySide, CriterionType criterionType) 
{ 
    // some code 
}