Я работаю на С# в VS 2012, добавляя XML-документацию к своему коду, и я случайно включил правило StyleCop (особенно SA1609), которое "проверяет, что общедоступное или защищенное свойство содержит заголовок документации с тег значения".
Также существует другое правило (SA1604, намеренно включенное в это время), которое "подтверждает, что заголовок документации содержит правильно отформатированный итоговый тег".
Однако Я изо всех сил пытаюсь понять, что вы положили в тег значения, который еще не указан в сводном теге. В настоящее время мои итоговые теги говорят что-то вроде строк "Получает или устанавливает что-то". Что следует добавить в соответствующий тег значения, чтобы это дополнять?
(Просто чтобы уточнить, я доволен настройкой StyleCop - он просто привлек мое внимание к тегу значений, когда я случайно включил все правила документации)
MSDN не помогает в этом:
- На странице с тегами значений подразумевается, что вы должны подробно описать, что используется поле поддержки (что кажется плохим идеей в интересах информации в любом случае).
- В их документации How-To по XML говорится, что "тег значения используется для описания значения свойства". Я даже не знаю, что это значит - это очень похоже на сводку для меня.
TL;DR
В чем смысл иметь как теги, так и значения в документации XML для свойств? Как их использовать без повторения?
