SQL Server Team-based Development - Red Gate Software

[Table_Name] ASC ,
[Column_ID] ASC ,
[Name] ASC
Listing 2-10: Extracting documentation from columns.
53
Chapter 2: Documenting your Database
For the rest of our database objects and routines, we can extract the contents of the
header in a number of different ways. Listing 2-11 shows a stored procedure that does
the job for any header. It will extract all headers in a routine, wherever they are in the
code, and will add all the inline header material. It will work for any type of header that
conforms to the /*** … */ (block comment) and – - – (inline) convention.
CREATE PROCEDURE Header
@RoutineCode VARCHAR(MAX) ,
@header VARCHAR(MAX) OUTPUT
/** summary: >
takes a routine's definition and extracts all header information from it,
including inline header information
Revisions:
– version : 1
Modification: Created the procedure
Author : Phil Factor
Date : 15/12/2009
– version : 2
Modification: Added mod to allow for nested comment blocks.
Author : Phil Factor
Date : 16/12/2009
example:
– code: >
Declare @Definition varchar(Max)
Declare @Header Varchar(max)
SELECT @Definition=Definition
FROM sys.sql_modules AS sm
JOIN sys.objects AS o ON sm.object_id = o.object_id
where OBJECT_NAME(sm.object_id) = 'header'
Execute header @Definition, @Header output
Select @Header
returns: the header block as an output variable
*/
AS