SQL Server Team-based Development - Red Gate Software

55
Chapter 2: Documenting your Database
THEN 'lineheader'
WHEN @PreviousState NOT IN ( 'lineheader',
'header' )
AND TheChar = ''''
THEN CASE WHEN @PreviousState = 'string'
THEN 'possibleEnd'
WHEN @PreviousState = 'possibleend'
THEN 'string'
WHEN @PreviousState 'string'
THEN 'string'
ELSE 'string'
END
WHEN @PreviousState = 'possibleend'
THEN 'code'
ELSE @PreviousState
END ,
@output = output = CASE WHEN @state = 'lineheader'
AND TheChar IN ( CHAR(13), CHAR(10) )
THEN ''
WHEN @PreviousState @state
AND @state = 'lineheader'
THEN CHAR(13) + CHAR(10) + TheChar
ELSE TheChar
END
--now assemble the header
SELECT @Header = ''
SELECT @Header = @Header + [Output]
FROM @parser
WHERE state IN ( 'header', 'lineheader' )
ORDER BY theorder
GO
Listing 2-11: Extracting documentation from routines.
We can now use this procedure to provide the headers for all the routines in the
database. The YAML output can then be converted into an XML fragment, then
translated into any required format with XSLT. The YAML can be consumed by Ruby
or Python and converted into native object formats.