SQL Server Team-based Development - Red Gate Software

Chapter 2: Documenting your Database
AS
GO
BEGIN
RETURN CASE WHEN PATINDEX(
'%[A-Za-z0-9-]%', @string COLLATE Latin1_General_CS_AI
) > 0 THEN 0
ELSE 1
END
END
Listing 2-2: A header in XMLDOCS format.
Extracting the XML file from the comments isn't too hard and, once we've got it, we can
put it into Sandcastle. What you want to aim for is as shown in Listing 2-3.
IsSpace string Function Returns Non-Zero if all characters in
@string are whitespace characters, 0 otherwise.
Select dbo.IsSpace('how many times must i tell you')
Select dbo.IsSpace(' <>[]{}"!@#$%9 )))))))')
Select dbo.IsSpace(' ????/>.<,')
integer: 1 if whitespace, otherwise 0
Listing 2-3: Extracting the XML file from the XMLDOCs header.
However, this is just a fragment from the file you need to produce. Notice that you ought
to escape certain characters. This makes the translation more complicated.
It isn't hard to see from this why the XMLDOCS convention never really caught on,
beyond using the summary tag to generate intellisense. It is awkward. It makes the code
44