c# - ponen - generar documentacion visual studio 2017
¿Qué etiqueta de comentario de documentación de C#xml se usa para ''verdadero'', ''falso'' y ''nulo''? (2)
Debe usar la entrada <see langword="true">
para que funcione correctamente para cualquier idioma que se esté usando.
¿Qué etiqueta de comentario de documentación de C # xml se usa para los literales true
, false
y null
?
En la propia documentación de Microsoft, estos literales aparecen en negrita . Por ejemplo, la documentación de la propiedad ArrayList.IsFixedSize aparece como:
Es cierto si el ArrayList tiene un tamaño fijo; de lo contrario, falso . El valor predeterminado es falso .
Ninguna de las etiquetas recomendadas de Microsoft parece aplicarse a esta situación. El mejor ajuste parece ser <c> , sin embargo, <c>true</c>
aparece como true
cuando Doxygen representa la documentación.
Sin embargo, el uso de <b>true</b>
con Doxygen produjo un texto en negrita como supongo que podría. Pero eso me deja preguntándome sobre la portabilidad de usar etiquetas HTML estándar con otras herramientas de generación de documentación como Sandcastle y GhostDoc .
Según el comportamiento de GhostDoc, <c> true </c> es la respuesta correcta. He votado el comentario de saravanan ahora que he podido confirmarlo.