SQL Server Team-based Development - Red Gate Software

45
Chapter 2: Documenting your Database
hard to read. You are liable to miss important information. More modern approaches
to structured text, such as YAML, provide a far easier and more intuitive approach, and
allow for a much more versatile way of handling paragraphs of text.
YAML and JSON
It is far better to take a human-oriented approach to headers. Here is a YAML version of
the header which is directly equivalent to the XMLDOCS version in Listing 2-2.
IF OBJECT_ID(N'IsSpace') IS NOT NULL
DROP FUNCTION IsSpace
GO
CREATE FUNCTION dbo.[IsSpace] ( @string VARCHAR(MAX) )
/**
summary: >
IsSpace string Function Returns Non-Zero if all characters
in s are whitespace characters, 0 otherwise.
example:
– code: Select dbo.IsSpace('how many times must i tell you')
– code: Select dbo.IsSpace(' []{}"!@#$%9 )))))))')
– code: Select dbo.IsSpace(' ????/>.