Documentación (XML) Configuración de la aplicación en Visual Studio 2010

Question

Recientemente creé un proyecto (C#) con Visual Studio (2010) y utilicé algunas configuraciones (que he creado en Propiedades).

El único lugar donde encontré donde puedo agregar algunos comentarios XML para mi documentación, sería en Settings.Designer.cs. Sin embargo, este archivo se genera automáticamente, así que cada vez que cambio la Configuración, los comentarios desaparecen.

Incluso Visual Studio da empezó a dar mewarnings, "Missing comentario XML para la publicidad visiblemente tipo o miembro ...."

Mi pregunta aquí es: Cuál es la manera más ordenada añadir comentarios XML a mi configuración?

• ¿Hay un lugar mejor que Settings.Designer.cs?
• ¿Debo evitar que el archivo se genere automáticamente? ¿Cómo?
• ¿Alguna otra forma?

estoy usando castillo de arena Constructor Archivo de ayuda por cierto

Answer 1

Si abre su configuración (utilizando el diseñador predeterminado), puede encontrar en la propiedad de la ventana de propiedades "Descripción". Rellene y se utilizará como resumen de comentarios XML en el archivo autogenerado.

Answer 2

lo hizo. Todavía no estoy seguro de si hay una forma mejor, pero agregué un SettingsDoc.xml a mi proyecto Sandcastle HFB. La desventaja de es que no se compila en Visual Studio, por lo que necesito actualizar y verificar referencias, etc.

Answer 3

En el archivo Settings.settings (no lo abra con el diseñador), agregue un atributo, p. "Descripción":

<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application"> 
    <Value Profile="(Default)">42</Value> 
</Setting> 

Esto generará

/// <summary> 
/// This property does blah blah blah 
/// </summary> 
[global...] 
public int MySetting { ... 

También es posible construir una herramienta que toma el archivo Settings.settings y crear un archivo de tema MAML. Llame a la herramienta en el evento de compilación de su proyecto y voilà.

En mis pruebas, si coloca la descripción como un atributo del elemento de configuración, se mantendrá si cambia la configuración en el diseñador, el atributo se mantendrá. Sin embargo, si lo coloca como elemento secundario del elemento Setting, se eliminará.