Как документировать проект базы данных в visualstudio



Основываясь на своих знаниях о документации на c# с помощью Visual studio, я активировал xml-файл в Properties- > SQLCLR-Build- > XML-Documentationfile.



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



В c# я бы сделал



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


Поэтому я сделал то же самое в sql



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


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



И даже после некоторых исследований о " visual studio SQLCLR build xml документация " я не могу найти какую-либо полезную информацию о том, как документировать мои процедуры, таблицы и функции таким образом, чтобы xml-documentation мог ее поймать



Я использую visual studio 2013 просто на случай, если это важно

663   1  

1 ответ:

Пара идей:

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

Comments

    Ничего не найдено.