Каков хороший стиль XDOC (или эквивалент C#) программы / плагина для SQL Server?

Question

Я ищу способ правильно прокомментировать мой код хранимой процедуры, чтобы я мог извлечь информацию в полезную документацию, такую ​​как XDOC (или эквивалент C#). Что-то, что предпочтительно легкий, было бы идеально.

Answer 1

Если вы уже используете Sandcastle для создания документации на основе XML-комментариев, которые генерирует Visual Studio, вы можете проверить следующий проект CodeProject:

SQL XML Документация

Он показывает, как вы можете использовать инструменты, которые вы уже используете, для генерации документации для ваших объектов SQL в том же стиле, что и документация, которую вы уже генерируете для остальной части своего кода.

Answer 2

Почему бы не использовать расширенные свойства, которые можно запрашивать с помощью простого оператора SQL?

SELECT * FROM sys.extended_properties

Нет необходимости в каких-либо подключаемых модулях, надстройках или иметь определенный сохраненный макет процесса...

Это то, что мы используем для каждого объекта в наших базах данных (и мы также используем Red Gate SQL Doc, чтобы дать некоторую структуру и хороший веб-сайт)