¿Cómo puedo comentar de esta Enumeración, de modo que la advertencia no aparece? Sí me doy cuenta de que los comentarios son innecesarios, pero si comentar es fácil y resuelve las advertencias, a continuación, me gustaría hacerlo.

Advertencias que aparecen:
Falta el comentario XML para que sea pública, tipo o miembro

///<summary>
///Conditional statements
///</summary>
public enum ConditionType
{
    Equal,
    NotEqual,
    GreaterThan,
    GreaterThanOrEqual,
    LessThan,
    LessThanOrEqual
}
InformationsquelleAutor Eric | 2010-07-22

2 Comentarios

  1. 96

    Como este:

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

    Puede que desee utilizar diferentes textos en los comentarios.

    Por el camino. su enumeración en realidad debería ser llamado ComparisonType.

    • Upvoted para la ComparisonType, esto es muy importante!
    • puede el valor de resumen obtenerse mediante programación, mientras que el bucle a través de la enumeración de los valores?
    • Estos valores sólo existen en los comentarios del documento XML archivo, si usted le dice al compilador para crear uno.
  2. 14

    Comentario de cada uno de los miembros:

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

    Puede que también desee comprobar hacia fuera GhostDoc para fácil comentar

Dejar respuesta

Please enter your comment!
Please enter your name here