This print for content only-size & color not accurate 7" X 9-1/4" / casebound / malloy

■

D E F I N I N G   E N C A P S U L AT E D   C L A S S  T Y P E S

176

8849CH05.qxd  10/22/07  1:34 PM  Page 176

---

So, why use XML to document our type definitions rather than HTML? The main reason is that

XML is a very “enabling technology.” Given that XML separates the definition of data from the pres-

entation of that data, we can apply any number of XML transformations to the underlying XML to

display the code documentation in a variety of formats (MSDN format, HTML, etc.).

When you wish to document your C# types in XML, your first step is to make use of the new

triple slash (///) code comment notations. Once a documentation comment has been declared,

you are free to use any well-formed XML elements, including the recommended set shown in

Table 5-2.

Table 5-2.

Recommended Code Comment XML Elements