Документирование (XML) настроек приложения в Visual Studio 2010 - PullRequest
Новая
       13

Документирование (XML) настроек приложения в Visual Studio 2010

8 голосов
/ 11 мая 2010

Я недавно создал (C #) проект с Visual Studio (2010) и использовал некоторые настройки (которые я создал в Свойствах).

Единственное место, где я мог бы добавить некоторые комментарии XML для своей документации, - это файл Settings.Designer.cs. Однако этот файл генерируется автоматически, поэтому всякий раз, когда я меняю Настройки, комментарии исчезают.

Даже Visual Studio начинает давать предупреждения: «Отсутствует комментарий XML для публичного представления или ввода ...»

Мой вопрос здесь: Какой самый удобный способ добавить комментарии XML в мои настройки?

  • Есть ли лучшее место, чем Settings.Designer.cs?
  • Должен ли я остановить файл от автоматической генерации? Как?
  • Есть другой способ?

Кстати, я использую Filecast Help Builder

Ответы [ 3 ]

10 голосов
/ 22 сентября 2010

Если вы открываете свои настройки (используя конструктор по умолчанию), вы можете найти в окне свойств свойство «Описание». Заполните его, и он будет использоваться в качестве сводки комментариев XML в автоматически сгенерированном файле.

2 голосов
/ 14 декабря 2012

В вашем файле Settings.settings (не открывайте его в конструкторе) добавьте атрибут, например, "Описание": 

<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. Вызовите инструмент в событии сборки вашего проекта и вуаля.

В моих тестах, если вы поместите описание в качестве атрибута элемента Setting, оно будет сохранено, если вы измените настройку в конструкторе, атрибут останется. Однако, если вы установите его как дочерний элемент элемента Setting, он будет удален.

0 голосов
/ 25 мая 2010

Сделал это. Я все еще не уверен, есть ли лучший способ, но я добавил файл SettingsDoc.xml в мой проект Sandcastle HFB. недостаток в том, что он не компилируется визуальной студией, поэтому мне нужно обновить и проверить ссылки и т.д.

...