c# - define - ¿Cómo comento un tipo enum visible públicamente?

enum to list c#

Question

¿Cómo puedo comentar este Enum para que no aparezca la advertencia? Sí, me doy cuenta de que los comentarios son innecesarios, pero si los comentarios son fáciles y resuelven las advertencias, me gustaría hacerlo.

Advertencias que aparecen: Falta el comentario XML para un miembro o tipo visible públicamente

/// <summary>
/// Conditional statements
/// </summary>
public enum ConditionType
{
Equal,
NotEqual,
GreaterThan,
GreaterThanOrEqual,
LessThan,
LessThanOrEqual
}

Answer 1

Comenta cada miembro:

/// <summary>
/// Conditional statements
/// </summary>
public enum ConditionType
{
/// <summary>
/// Tests for equality
/// </summary>
Equal,
/// <summary>
/// Tests for inequality
/// </summary>
NotEqual,
// etc..
}

También es posible que desee comprobar GhostDoc para facilitar los comentarios

Answer 2

Me gusta esto:

/// <summary>
/// Conditional statements
/// </summary>
public enum ConditionType
{
///<summary>A == B</summary>
Equal,
///<summary>A != B</summary>
NotEqual,
///<summary>A > B</summary>
GreaterThan,
///<summary>A >= B</summary>
GreaterThanOrEqual,
///<summary>A < B</summary>
LessThan,
///<summary>A <= B</summary>
LessThanOrEqual
}

(Sí, esto puede ser muy tedioso)

Es posible que desee utilizar diferentes textos en los comentarios.

Por cierto. su enumeración en realidad debería llamarse ComparisonType .