Documentation des paramètres d'application (XML) dans Visual Studio 2010

Question

J'ai récemment créé un projet (C#) avec Visual Studio (2010) et utilisé certains paramètres (que j'ai créés dans Propriétés).

Le seul endroit où j'ai trouvé où je peux ajouter des commentaires XML pour ma documentation serait dans Settings.Designer.cs. Cependant, ce fichier est généré automatiquement, donc chaque fois que je change les paramètres, les commentaires ont disparu.

Même Visual Studio donne a commencé à donner mewarnings, « commentaire XML manquant pour la publicité visible type ou membre .... »

Ma question ici est: Quelle est la plus élégante façon d'ajouter des commentaires XML à mes paramètres?

• Y at-il un meilleur endroit que Settings.Designer.cs?
• Devrais-je empêcher le fichier d'être généré automatiquement? Comment?
• Tout autre moyen?

J'utilise Sandcastle Help File Builder par la façon dont

Answer 1

Si vous ouvrez vos paramètres (en utilisant le concepteur par défaut), vous pouvez trouver dans la propriété Propriétés de la fenêtre "Description". Remplissez-le et il sera utilisé comme résumé de commentaire XML dans un fichier autogénéré.

Answer 2

a fait. Je ne suis toujours pas sûr s'il y a un meilleur moyen, mais j'ai ajouté un SettingsDoc.xml à mon projet Sandcastle HFB. inconvénient est qu'il ne se compile pas par studio visuel, donc j'ai besoin de mettre à jour et vérifier les références etc moi-même.

Answer 3

Dans votre fichier Settings.settings (ne l'ouvrez pas avec le concepteur), ajoutez un attribut, par ex. « Description »:

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

Cela va générer

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

Vous pouvez également créer un outil qui prend le fichier Settings.settings et créer un fichier sujet GAML. Appelez l'outil dans l'événement de construction de votre projet et voilà.

Dans mes tests, si vous mettez la description en tant qu'attribut de l'élément Setting, elle sera conservée si vous modifiez le paramètre dans le concepteur, l'attribut sera conservé. Cependant, si vous le mettez en tant qu'enfant de l'élément Setting, il sera supprimé.