2011-02-23 8 views
5

Tengo esta función:Cómo rótulo de código en C# documentación XML

public static string Join(this IEnumerable<string> strings, string separator) 
{ 
    return string.Join(separator, strings.ToArray()); 
} 

que quiero documentar.
Quiero que la etiqueta <return> diga string.Join(separator, strings.ToArray()) ya que cualquiera que pueda leer el código C# dice más de mil palabras. Sin embargo, cuando uso

<return>string.Join(separator, strings.ToArray())</return> 

continuación string.join (separador, strings.ToArray()) se indicará como texto plano, lo que hace que sea casi ilegibles. Así que traté

<return><code>string.Join(separator, strings.ToArray())</code></return> 

pero esto siempre crea un nuevo párrafo ...

Así que aquí es mi pregunta:
¿Hay una manera de dar formato a un trozo de texto para que aparezca como si se tratara de código ? Estaría satisfecho con una fuente de ancho fijo.

Respuesta

8

La etiqueta <c> suena como si fuera lo que estás buscando. Consulte MSDN's tag reference para obtener más detalles.

Dicho esto, ¿está seguro de que desea que la documentación se refiera directamente a las acciones realizadas por la función? ¿Qué pasa si decides cambiar la implementación más tarde? Sé que este es un ejemplo bastante trivial, ¡pero algo para pensar! :)

+0

'' ¡Gracias! No tengo idea de por qué no vi esto ... – sbi

Cuestiones relacionadas