2010-07-22 9 views
26

¿Cómo comento este Enum para que la advertencia no aparezca? Sí, me doy cuenta de que los comentarios son innecesarios, pero si comentar es fácil y resuelve las advertencias, me gustaría hacerlo.¿Cómo comento un tipo público visible Enum?

advertencias que aparecen: comentario XML que falta por un tipo visible para el público o miembro

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

Respuesta

73

De esta manera:

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

Usted puede quiero usar diferentes textos en los comentarios.

Por cierto. su enum debería llamarse en realidad ComparisonType.

+1

upvoted para la ComparisonType, esto es muy importante! – Lucas

10

comentario a 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 hacia fuera para facilitar GhostDoc comentando

Cuestiones relacionadas