Delimitadores para etiquetas de documentación en C#

El delimitador multilínea comienza con /** y termina con */. Puede abarcar muchas líneas, por lo que los caracteres iniciales de este delimitador están en una línea, los caracteres finales en otra línea, y cualquier texto entre ellos como el comentario.

Aquí hay un ejemplo de que se utiliza para contener comentarios en una sola línea y en varias líneas:

1234567891011121314151617classAccount{/** <resumen;};Class constructor</resumen;};param nombre="accountNo"``el número de cuenta.</param */publicAccount(string accountNo,int balance){ AccountNo = accountNo; Balance = balance;}/** <summary >el número de cuenta del cliente </summary;*/publicstring AccountNo {get;set;}publicint Balance {get;set;}}

csharp

Del ejemplo anterior, sólo se procesará la parte que comienza con el resumen. Los tres formatos de etiquetas producen los mismos comentarios. A continuación se presentan algunas reglas de formato que deben tenerse en cuenta al utilizar este delimitador.

En la línea que contiene el delimitador /**, si el resto de la línea es espacio en blanco, la línea no se procesa para comentarios.

Si el primer carácter después del delimitador /** es un espacio en blanco, ese carácter de espacio en blanco se ignora y el resto de la línea se procesa. De lo contrario, todo el texto de esa línea después del delimitador /** se procesa como parte del comentario.

Para las líneas que siguen a la que comienza con el delimitador /**, el compilador busca un patrón común al principio de cada línea. Si el compilador encuentra un patrón común al principio de cada línea que no comienza con el delimitador /** o el delimitador */, ignora ese patrón para cada línea. El patrón puede consistir en un asterisco seguido de un espacio en blanco opcional.

12345678910/** * <summary>Class constructor</summary;*;param name="accountNo "*;el número de cuenta.</param

csharp

En la línea que contiene el delimitador */, si sólo hay espacios en blanco hasta el delimitador */, esa línea es ignorada. En caso contrario, el texto se procesa como parte del comentario, sujeto a las reglas de concordancia de patrones descritas anteriormente.