C# 方法参数 XML-文档问题

Question

假设，我有一个方法，其参数是 classes 和已经定义的文档：

/// <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 class 有自己的 xml-文档：

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

正如您在 GetCriterion 方法中看到的那样，我没有为 plySide 参数标记定义任何文档。我的问题是我应该复制参数的描述还是应该删除参数标签？

Answer 1

您不应复制它，而应给出参数的上下文感知描述。在你的情况下可能是这样的（也许这是完全错误的，但我不知道你的方法的实现和意图）：

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

Answer 2

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

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

这些通常会有微妙的（或不太微妙的）不同。

C# 方法参数 XML-文档问题

C# method parameter XML-documentation issue

c#

visual-studio

xml-documentation