2015-11-09 8 views
2

Основываясь на моих знаниях о документации C# через Visual studio, я активировал XML-файл в свойствах -> SQLCLR-Build -> XML-Documentationfile.Как документировать проект базы данных в visualstudio

теперь файл XML создается, но я не в состоянии выяснить, какие теги разрешены и как начать документацию

в C# я бы делать

/// <summary> 
/// does some stuff 
/// </summary> 
public .... 

так я сделал то же самое в sql

--- <summary> 
--- does some stuff 
--- </summary> 
CREATE PROCEDURE .... 

но созданный xml не отражает мою документацию.

и даже после того, как некоторые исследования о «Visual Studio SQLCLR документации строить XML» Я не могу найти полезную информацию о как документировать свои процедуры, таблицы и функции таким образом, что XML-справки о состоянии на поймать его

Я использую Visual Studio 2013 только в случае, если это ВАЖНАЯ

ответ

3

пара идей:

  1. Существует проект по codeproject.com называется SQL XML Documentation, что извлекает XML-комментарии из SQL-скриптов с помощью Microsoft SandCastle. Я никогда не использовал его, хотя я не могу ручаться за него.
  2. Если вам необязательно нужна документация в XML, вы можете воспользоваться свойством Description в области свойств Visual Studio. Описание будет храниться как расширенное свойство в SQL Server. enter image description here
+0

Thx for for both way, второй работает только для таблиц. Таким образом, нет собственного способа документировать мои процедуры в визуальной студии, даже если этот CheckBox активирует вывод XML? Я проверю ваше первое предложение, потому что оно похоже на мои нужды, на данный момент +1 :-) – WiiMaxx

+0

@WiiMaxx Правильно, в VS нет собственного способа сделать это. Этот флажок применяется только к сборкам CLR. – Keith