Пропавшие без вести XML-комментария для публично видимого типа или участника

Я получаю это предупреждение: "Пропуская XML-комментарий для публично видимого типа или участника".

Как решить это?

364
задан J.-B. C. 20 August 2012 в 00:05
поделиться

3 ответа

5 опций:

  • Заполняют комментарии для документации (большой, но трудоемкий)
  • Выключают поколение комментария (в свойствах проекта)
  • , Отключают предупреждение в свойствах проекта (в 'Свойствах проекта', переходит к Свойствам проекта-> Сборка> "Ошибки и предупреждения" (раздел), Отключает предупреждения (текстовое поле), добавляет 1591 (список разделенных запятой значений))
  • , Использование #pragma warning disable 1591 для отключения предупреждения только для некоторых битов кода (и #pragma warning restore 1591 впоследствии)
  • Игнорирует предупреждения (плохая идея - Вы пропустите новые "реальные" предупреждения)
644
ответ дан MiFreidgeim SO-stop being evil 23 November 2019 в 00:09
поделиться

Вставьте XML-комментарий.;-)

/// <summary>
/// Describe your member here.
/// </summary>
public string Something
{
    get;
    set;
}

Это может появиться как шутка на первый взгляд, но он может на самом деле быть полезным. Для меня оказалось полезным думать о том, что методы делают даже для закрытых методов (если не действительно тривиальный, конечно).

22
ответ дан Matthias Meid 23 November 2019 в 00:09
поделиться

Добавьте XML-комментарии к публично видимым типам и участникам, конечно:)

///<Summary>
/// Gets the answer
///</Summary>
public int MyMethod()
{
   return 42;
}

Вам нужны эти <summary> комментарии типа ко всем участникам - они также обнаруживаются в intellisense всплывающем меню.

причина Вы добираетесь, это предупреждение состоит в том, потому что Вы установили свой проект произвести документацию xml файл (в настройках проекта). Это полезно для библиотек классов (.dll блоки), что означает, что пользователи Вашего .dll получают intellisense документацию для Вашего API тут же в Visual Studio.

я рекомендую вовлечь себя копия GhostDoc Visual Studio AddIn.. Делает документирование намного легче.

89
ответ дан Isak Savo 23 November 2019 в 00:09
поделиться
Другие вопросы по тегам:

Похожие вопросы: