Документированные (XML) Настройки приложения в Visual Studio 2010
https://stackoverflow.com/questions/2809582
-
25-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Я недавно создал проект (C #) с Visual Studio (2010) и использовал некоторые настройки (которые создали в рамках свойств).
Единственное место, где я нашел где я могу добавить некоторые комментарии XML для моей документации, будет в настройках .designer.cs. Однако этот файл автоматически генерируется, поэтому всякий раз, когда я изменяю настройки, комментарии исчезли.
Даже Visual Studio дает начал давать Mewarnings, «отсутствует XML-комментарий для публично типа или члена ...».
Мой вопрос здесь: каков нужен способ добавить xml Комментарии к моим настройкам?
- Есть ли лучшее место, чем настроек .designer.cs?
- Должен ли я остановить файл от автоматического создания? Как?
- Любым другим путем?
Я использую SandcaCly Celp Caid Custister кстати
Решение
Если вы откроете свои настройки (используя Designer Designer), вы можете найти в своем свойстве свойств свойств «Описание». Заполните его, и он будет использоваться в качестве комментариев XML комментариев в автогенерационном файле.
Другие советы
В ваших настройках. Файл (не открывайте его с помощью дизайнера), добавьте атрибут, например, «Описание»:
<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application">
<Value Profile="(Default)">42</Value>
</Setting>
Это будет генерировать
/// <summary>
/// This property does blah blah blah
/// </summary>
[global...]
public int MySetting { ...
Вы также можете построить инструмент, который принимает файл Settings.settings и создать файл темы MAML. Вызовите инструмент в соревнованиях по сборке вашего проекта и Voilà.
В моем тестах, если вы поместите описание в качестве атрибута элемента настроек, он будет сохранен, если вы измените настройку в Designer, атрибут будет сохранен. Однако, если вы поместите его в детский элемент настройки, он будет удален.
Сделал это. Я до сих пор не уверен, что есть лучший способ, но я добавил settingsdoc.xml в мой проект Sandcastle HFB. Недостаток состоит в том, что он не сочетается с компиляцией Visual Studio, поэтому мне нужно обновлять и проверять ссылки и т. Д.
