Ich habe kürzlich ein (C #) Projekt mit Visual Studio (2010) erstellt und einige Einstellungen verwendet (die ich unter Eigenschaften erstellt habe).
Der einzige Ort, an dem ich XML-Kommentare für meine Dokumentation hinzufügen kann, wäre Settings.Designer.cs. Allerdings wird diese Datei automatisch generiert. Wenn ich die Einstellungen ändere, sind die Kommentare weg.
Sogar Visual Studio gibt an, Warnmeldungen zu geben, "Fehlender XML-Kommentar für Werbung sichtbar Typ oder Mitglied ...."
Meine Frage hier ist: Was ist der beste Weg, XML-Kommentare zu meinen Einstellungen hinzuzufügen?
Ich verwende übrigens Sandcastle Help File Builder
Fügen Sie in Ihrer Settings.settings-Datei (nicht mit dem Designer öffnen) ein Attribut hinzu, z. "Beschreibung":
%Vor%Dies erzeugt
%Vor%Sie können auch ein Tool erstellen, das die Settings.settings-Datei übernimmt und eine MAML-Themendatei erstellt. Rufen Sie das Tool im Build-Ereignis Ihres Projekts auf und voilà.
Wenn Sie in meinen Tests die Beschreibung als Attribut des Setting-Elements angeben, wird das Attribut beibehalten, wenn Sie die Einstellung im Designer ändern. Wenn Sie es jedoch als untergeordnetes Element von Setting platzieren, wird es gelöscht.
Hat es getan. Ich bin mir immer noch nicht sicher, ob es einen besseren Weg gibt, aber ich habe eine SettingsDoc.xml zu meinem Sandcastle HFB Projekt hinzugefügt. Nachteil ist, dass es nicht von Visual Studio kompiliert wird, also muss ich selbst Referenzen aktualisieren und überprüfen.
Tags und Links c# visual-studio-2010 documentation application-settings