Dokumentacja (XML) Ustawienia aplikacji w Visual Studio 2010

Niedawno utworzyłem projekt (C#) w Visual Studio (2010) i użyłem niektórych ustawień (które utworzyłem w obszarze Właściwości).Dokumentacja (XML) Ustawienia aplikacji w Visual Studio 2010

Jedyne miejsce, w którym mogę dodać komentarze XML do mojej dokumentacji, znajdzie się w Settings.Designer.cs. Ten plik jest generowany automatycznie, więc po każdej zmianie ustawień komentarze zniknęły.

Nawet Visual Studio daje zaczął dawać mewarnings „Missing komentarz XML dla rozgłosu wyraźnie wpisać lub członek ....”

Moje pytanie brzmi: Jaki jest neatest sposób, aby dodać komentarz XML moje ustawienia?

Czy jest lepsze miejsce niż Settings.Designer.cs?
Czy powinienem zatrzymać automatyczne generowanie pliku? W jaki sposób?
W inny sposób?

Używam Sandcastle Help File Builder przy okazji

Źródło

2010-05-11 SirLenz0rlot

Po otwarciu ustawień (przy użyciu domyślnego projektanta) można znaleźć we właściwości okna właściwości "Opis". Wypełnij go i będzie on używany jako podsumowanie komentarza XML w automatycznie wygenerowanym pliku.

Źródło

2010-09-22 06:50:32 veselka

Nie jestem w stanie tego sprawdzić, ale dzięki. To pytanie zostało opublikowane przez długi czas, ale spróbuję go w przyszłości. Dzięki – SirLenz0rlot

Nie jestem również w stanie go znaleźć. Ale myślę, że to, co mówisz, to "Zasoby", które różnią się od ustawień. – Gqqnbig

Chciałem tylko wskazać, że musisz wybrać odpowiednie ustawienie, aby edytować jego opis w oknie właściwości. –

zrobił. Nadal nie jestem pewien, czy jest lepszy sposób, , ale dodałem plik SettingsDoc.xml do mojego projektu Sandcastle HFB. Wada polega na tym, że nie jest ona kompilowana przez studio graficzne, więc muszę aktualizować i sprawdzać referencje itp.

Źródło

2010-05-25 12:59:54 SirLenz0rlot

W swoim pliku Settings.settings (nie otwieraj go razem z projektantem) dodaj atrybut, np. „Opis”:

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

To wygeneruje

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

Można także zbudować narzędzie, które zajmuje plik Settings.settings i utworzyć plik temat MAML. Wywołaj narzędzie w zdarzeniu budowania projektu i voila.

W moich testach, jeśli umieścisz opis jako atrybut elementu Setting, będzie on zachowany, jeśli zmienisz ustawienie w projektancie, atrybut zostanie zachowany. Jeśli jednak umieścisz go jako element podrzędny elementu Setting, zostanie on usunięty.

Źródło

2012-12-13 20:51:56 laurian

Dokumentacja (XML) Ustawienia aplikacji w Visual Studio 2010

Odpowiedz

Powiązane problemy