| **Navigation:**  Text Editor >====== XML Documentation Comments ====== | [[workingthreadmanager.htm|{{btn_prev_n.gif|Previous page}}]][[coming future.htm|{{btn_home_n.gif|Return to chapter overview}}]][[ide code regions.htm|{{btn_next_n.gif|Next page}}]] |
|  ||

{{newcnet.jpg|NewCNet.jpg}}

This type of comment provides the ability to generate XML documentation for Clarion .Net source files. (For more information see [[http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vcoriXMLDocumentation.asp|XML Documentation]] in MSDN). All comments started with "!!!" are considered as documentation comments.

**Example:**

**!!!<;summary> **

**!!! This is a class A **

**!!!<;/summary> **

**A  CLASS **

**    ' **

**   END **

**Quick XML Documentation**

The Quick XML Documentation feature is only available in Clarion.NET.

To write a documentation comment to any target object, start the comment with 3 exclamation marks:

For example:

**!!! <;summary>**

**!!! Special Formatting Documentation**

**!!! <;/summary>**

**!!! <;param name="b">The parameter comment<;/param>**

**!!! <;remarks>**

**!!! This is a remark.**

**!!! <;/remarks>**

**class.proc  procedure(long b)**

**   code**

If you use XML-styled documentation comment syntax (as in the above example) you will see special formatting in the tooltip text provided by the Code Completion. Otherwise, the comments will be displayed in the tooltip "as is".

Documentation comments must precede the object declaration. For procedures, you can have comments for the procedure declaration or procedure definition (the comment for declaration has higher priority).

Other examples:

**test  long !comment to test**

**test1 long**

In the example above, //test1// will have a "comment to test" documentation comment. The //test// variable will not, since it comes before the //test1// variable declaration.

**! comment1**

**c class**

**p procedure !proc comment**

**end**

In this example, the //p// procedure will have no documentation comment, but the //c// class will display both comment lines //comment1// and //proc comment//.