30.06.2013 Views

SQL Server Team-based Development - Red Gate Software

SQL Server Team-based Development - Red Gate Software

SQL Server Team-based Development - Red Gate Software

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Chapter 2: Documenting your Database<br />

The rest of the standard tags are listed in Table 2-1.<br />

Tag Purpose<br />

Set text within a paragraph in a code-like font to indicate that<br />

it is a token.<br />

Set one or more lines of code or output.<br />

An example of the routine's use.<br />

The errors or exceptions that can be thrown by the code.<br />

Create a list or table.<br />

Delimits a paragraph within the text.<br />

Describe a parameter for a routine, procedure, method or<br />

constructor.<br />

Identify that a word is a parameter name.<br />

Document the security accessibility of a routine or member.<br />

Describe a type.<br />

Describe the results, variables, or return value of a routine or<br />

method.<br />

Specify a link.<br />

Generate a See Also entry e.g. .<br />

Describe a member of a type.<br />

The name of the type parameter, with the name enclosed in<br />

double quotation marks (" ").<br />

Describe a property or variable.<br />

Table 2-1: Standard tags in XMLDOCS.<br />

42

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!