C# Methodenparameter XML-Dokumentation Ausgabe

Question

Angenommen, ich habe eine Methode, die Parameter sind Klassen mit bereits definierten Dokumentation:

/// <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 Klasse hat es ist eigene XML-Dokumentation:

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

Wie Sie kann in GetCriterion Methode ich habe kein Dokument für die plySide Param-Tag zu definieren. Meine Frage ist, sollte ich die Beschreibung eines Parameters duplizieren oder sollte ich Param-Tags entfernen?

Answer 1

Die PlySide Dokumentation beschreiben, was der Typ ist.

Die plySide Dokumentation sollte beschreiben, welche Rolle die Parameter im GetCriterion Methode spielt.

Diese werden normalerweise subtil (oder nicht so subtil) anders sein.

Answer 2

Sie sollten es nicht duplizieren, sondern eine kontextbezogene Beschreibung des Parameters angeben. In Ihrem Fall könnte es so etwas wie diese (vielleicht ist es toally falsch, aber ich weiß nicht, die Umsetzung und die Absicht Ihrer Methode):

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