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标签定义任何DOC。我的问题是我应该复制参数的描述，还是应该删除参数标签？

Answer 1

PlySide文档将描述什么类型是。

plySide文档应描述参数在GetCriterion方法中扮演的角色。

这些通常会巧妙(或不那么巧妙(。

Answer 2

您不应该重复它，而是要对参数进行上下文意识描述。在您的情况下，这可能是这样的(也许是易于遗憾的，但我不知道您的方法的实现和意图(：

/// <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
}