generate - summary c# documentation

Documentación de C#xml: ¿cómo crear notas?

Question

Quiero lograr algo similar al cuadro amarillo "Nota:" en la sección de comentarios en esta página de MSDN en mi propia documentación.

Estoy usando sandcastle y el constructor de archivos de ayuda de sandcastle para generar un sitio web de referencia de las etiquetas de documentación. ¿Qué tengo que escribir para lograr ese cuadro de notas?

Answer 1

No es una solución directa, sino una alternativa:

NDoc admite una etiqueta <note> . Como NDoc está desactualizado, puede buscar esta característica en NDoc3 , que definitivamente vale la pena mirar, ya que también es capaz de crear documentación HTML simple, no solo documentación en línea que asume asp.net.

Answer 2

/// <summary><c>Increment</c> method increments the stored number by one.
/// <note type="caution">
/// note description here
/// </note>
/// </summary> 

Mire el archivo "C: / Archivos de programa / Sandcastle / Examples / Sandcastle / test.cs"

Tipo podría ser uno de:

• Nota
• propina
• precaución
• seguridad
• importante
• vb / VB / VisualBasic / nota básica visual
• cs / CSharp / c # / C # / nota visual c #
• cpp / c ++ / C ++ / CPP / nota visual de c ++
• JSharp / j # / J # / visual j # nota
• implementar
• llamador
• heredar