Appendix E Generating Documentation in Visual Studio 1331 /// this is a comment /// In this comment, the first line begins element summary, the second line defines the text that element summary contains and the third line closes element summary. As we will discuss later in this text, the documentation tool will document only the text within these summary tags. All XML declaration comments (excluding the three forward slashes) must contain well-formed XML. Like general comments, the compiler does not translate documentation comments to MSIL (Microsoft Intermediate Language), so they do not become part of the program. Because the documentation tool creates XML files, documentation comments can contain certain types of markup, such as HTML tags and customized XML content. For example, the documentation comment /// /// Sorts integer array using MySort algorithm /// contains the HTML tags and . In the generated HTML files, MySortappears as emphasized text (normally italic). E.3 Documenting C# Source Code Figure E.1, Fig. E.2 and Fig. E.3 present a modified version of the Point, Circle and CircleTest classes from Section 9.4 that contains XML documentation comments. In the text that follows the example, we discuss each XML element used in the documentation comments. In Section E.4, we discuss how the documentation tool can generate XML documentation from this file. 1 // Fig. E.1: Point.cs 2 // Class Point maintains an X and Y coordinate. 3 4 using System; 5 6 namespace CircleTest 7 { 8 /// 9 /// Class Point defines a point as a pair 10 /// of x and y coordinates. 11 /// 12 public class Point 13 { 14 /// 15 /// This private member of Point 16 /// represents the x coordinate. 17 /// 18 /// The x coordinate as an integer. 19 private int x; Fig. E.1 Fig. E.1Fig. E.FiFi1g. E.1g. E.1Pointmarked up with XML comments. (Part 1 of 3.)
If you are looking for affordable and reliable webhost to host and run your business application visit our ftp web hosting services.
This entry was posted
on Friday, October 26th, 2007 at 1:07 pm and is filed under Tomcat.
You can follow any responses to this entry through the RSS 2.0 feed.
You can leave a response, or trackback from your own site.