Использование CSDL для документирования объектов

Question

CSDL включает элементы Документация/резюме и документация/LongDescription, которые according to MSDN, могут использоваться для документирования объектов. Содержимое этих элементов удобно отображать в окне свойств поверхности проектирования сущности, поэтому в этих полях легко записывать несколько заметок, когда вы работаете с объектами.

Поскольку файл EDMX является XML, было бы легко написать таблицу стилей XSLT, чтобы вытащить документацию из этих элементов. Есть ли стандартный инструмент для этого? Существуют ли другие преимущества использования полей документации CSDL? Кто-нибудь использует эти поля, и если да, вы нашли их эффективным способом документировать ваши сущности?

Answer 1

Данные документации, хранящиеся в CSDL, испускаются как комментарии XML-документа в сгенерированном коде. В результате, он будет появляться в IntelliSense всплывающих подсказках в Visual Studio автомагический:

Если вы хотите использовать его для более формальной документации вы можете использовать SandCastle (необязательно вместе с отличным фронтэндом SHFB), или другой инструмент извлечения Xml DocComment для создания файлов справки Windows или справочных веб-сайтов, содержащих документацию.

Если база данных документирована с использованием документации атрибутов в SQL Server, вы можете извлечь эту документацию из базы данных и заполнить комментарии SSDL и СКТ с помощью этого инструмента: http://huagati.com/edmxtools/