Расширение позволяет сформировать .cs кода на основе .sql файла для которого установлен генератор кода (Custom Tool): Sql2CsGenerator.
##Параметры
Параметры определяются на основании инструкций объявления (DECLARE) с установленным значением по-умолчанию.
Например:
DELARE @index INT = 0
Будет сформирован параметр
int index
По-умолчанию все параметры являются обязательными, если нужно объявить не обязательный параметр, то после объявления нужно добавить комментарий --optional.
Пример:
DELARE @index INT = 0 --optional
Будет сформирован параметр
int? index
##XML Документация
Для всего запроса и его параметров можно добавить комментарии, которые будут формировать XML документацию (/// ...), см. ниже {Comment}
Первый комментарий в запросе будет использоваться для элемента <summary>
Комментарий перед объявлением параметра будет использоваться для элемента <param>
##Макросы шаблона
При описании шаблона можно использовать следующие макросы
- {SqlText} - SQL текст запроса
- {SqlMinimizedText} - Сжатый SQL текст запроса, без комментариев и переносов строк
- {Description} - Описание запроса (первый комментарий в .sql файле)
- {FileName} - Имя файла .sql (без расширения)
- {Folder} - Имя папки, в которой находится .sql файл
- {Comment} - Описание запроса в формате XML документации (/// ...)
- {ParametersDeclaration} - Объявление параметров запроса в формате (param1 type, param2 type, ...)
- {FileNamespace} - namespace на основании расположения .sql файл
- {FolderNamespace} - namespace на основании расположения папки в которой находится .sql файл
Пример шаблона
namespace {FolderNamespace}
{
public partial class {Folder}
{
{Comment}
public string {FileName}({ParametersDeclaration})
{
#if DEBUG
return $@""{SqlText}"";
#else
return $@""{SqlMinimizedText}"";
#endif
}
}
}