Chapter 18 Working with C#

Documentation tags

To generate documentation tags, you should use the Comment box in property sheets. You can use any documentation tag before and after documentation, for example you can type <summary> and </summary>.

If you add a tag, the documentation is preceded by /// in the generated code. During reverse engineering, the / signs used to identify documentation are removed and the start and end documentation tags are automatically added.

In the following example, you add a comment to class Employee:

The following code is generated:

   ///  <summary>
   ///   this is documentation
   ///   this is documentation
   ///   </summary>

Copyright (C) 2007. Sybase Inc. All rights reserved.