XML Automatic Documentation Tags

Figure 2

The <c>, and the <code>  tags

Usage: <c>text</c>

The <c> tag identify that the text within it is source code. This tag is for a single line of source code, use <code>text</code> to indicate multiple lines of source code.

The significance of those two tags is that if you wrote your code directly inside any other tag without specifying then, then your code will of course appear in the final documentation but will be handled differently. For example, your code will be warped according to the width of the window inside which it appears and this is of course is an undesirable behavior.

The following lines give you an example about that. See the final document in figure 3.

Recall that ... In tutorial Automatic Documentation Generation in ASP.NET Applications we have explained to you why it's hard to produce software documentation using the traditional documentation schemes of Software Engineering. We, then, proposed a much more practical and super fast technique for producing documentation by writing them within your source code and then extracting them into a comprehensive and easy to read / browse complete document. In our previous work, we used Microsoft Visual Studio 2005 to extract the documentation from source code into an XML file. We then worked out the procedure of how to feed this XML file to NDOC to produce our complete documentation CHM file. As you may recall, writing these documentation within your source code needs a special syntax to be followed. We have presented some brief information about the <summary> tag along with some other elementary tags as well. Here, in this tutorial, we will illustrate in more details how you can benefit from this technique to the most extent by using some other recommended XML tags to give more comprehensiveness and functionality to your final documentation file. The <summary> tag Usage: <summary>text</summary> Use the summary tag to give an overall description about your class member. Summary text is the only text that appears in the IntliSense feature. This tag is generated automatically after you type the famous ('''). As an example about this tag see the following lines, then see the final generated document in figure1.    31     ''' <summary>   32     ''' This is summary of Function1   33     ''' </summary> Figure 1 The <remarks> tag
	10 ''' <remarks>   11 ''' More information about class1   12 ''' </remarks>

ads2