Affordable, Php5, Web Design Programs - Tomcat Web Hosting

Appendix E Generating Documentation in Visual Studio 1343 60 not private members x 61 and y. 62 63
64 The x coordinate of the circle 65 66
67 The y coordinate of the circle. 68 69 70 71 72

73 Converts the Point to 74 string format. 75

76 77 Returns a string in format: 78 [x coordinate, y coordinate]. 79 80 81 82 83

84 Provides get and set access to member 85 x. 86

87 88 X accesses the value of the 89 x data member. 90 91 92 93 94

95 Provides get and set access to member 96 y. 97

98 99 Y accesses the value of the 100 y data member. 101 102 103 104 105

106 This private member of Circle 107 represents the radius. 108

109 110 111 112

Fig. E.8 Fig. E.Fig.Fi E.8g. E.88XML documentation generated by Visual Studio .NET. (Part 3 of 6.) Fig. E.
If you are looking for cheap and quality webhost to host and run your website check Jboss Web Hosting services.

1342 Generating Documentation in Visual Studio Appendix E 7 8 9

10 Class Circle inherits from class 11 Point. It has an additional member to 12 represent the radius, a property that provides 13 accessto it and method Area to 14 compute the area of the circle. 15

16 17 18 19

20 Class Point defines a point as a pair 21 of x and y coordinates. 22

23 24 25 26

27 This protected member of Point 28 represents the x coordinate. 29

30 The x coordinate as an integer. 31 32 33 34

35 This protected member of Point 36 represents the x coordinate. 37

38 The y coordinate as an integer. 39 40 41 42

43 Default constructor for class Point. 44

45 46 Sets properties X and Y to 0. 47 48 49 50 52

53 Constructor for Point 54 that accepts two integers 55 that represent the x and y coordinates of the point. 56

57 58 Uses X and Y 59 properties to set the coordinates of the point, Fig. E.8 FiFiFig.g.g. E.E.E.888Fig. E. XML documentation generated by Visual Studio .NET. (Part 2 of 6.)
If you are in need for chaep and reliable webhost to host your website, our recommendation is http web server services.

Appendix E Generating Documentation in Visual Studio 1341 Fig. E.7 Fig. E.Fig..Fi E7g. E.7E.7XHTML documentation of method Areamethod of class Circle. Fig. E.5 Creating XML Documentation Files In this section, we discuss how to generate an XML documentation file that contains all elements in the source code comments. An application then can read such a file and create custom documentation from its information. To create an XML documentation file for a project, right-click on the project in the Solution Explorer and select Properties. Select the Configuration folder, then the Build tab. Change the XML Documentation File property to the name of the file that will store the XML documentation and click OK. If this file does not exist, Visual Studio will create the file and place it in the bin/Debug directory of the current project. Select Build > Build Solution to compile the project and create the XML document. Figure E.8 shows the XML document generated for the example in Fig. E.1 Fig. E.3. 1 2 3 4 Point-Circle 5 6 Fig. E.8 Fig. E.Fig.Fi E.8g. E.88XML documentation generated by Visual Studio .NET. (Part 1 of 6.) Fig. E.
We recommend you use shared web hosting services, because many users agree that it is cheap, reliable and customer-satisfying webhost.

1340 Generating Documentation in Visual Studio Appendix E Fig. E.5 Fig. E.Fig..Fi E5g. E.5E.5Saving a document to a file. Fig. Fig. E.6 Fig. E.Fig..Fi E6g. E.6E.6XHTML documentation of class Circle. Fig.
We highly recommend you visit web and email hosting services if you need stable and cheap web hosting platform for your web applications.

Appendix E Generating Documentation in Visual Studio 1339 E.4 Creating Comment Web Pages In this section, we show how Visual Studio .NET can create documentation in Web-page format from source code that contains the XML documentation comments. We demonstrate this feature on the project containing the classes of Fig. E.1, Fig. E.2 and Fig. E.3. After opening this project, select Tools > Build Comment Web Pages (Fig. E.4). The Build Comment Web Pages window will appear, enabling the developer to specify the project(s) containing the files that Visual Studio .NET should document (Fig. E.5). If the developer selects Build for entire Solution, Visual Studio .NET will document all files in the current solution. If the developer selects Build for selected Projects, Visual Studio .NET will document only those files in the project that the developer specifies. In addition, the developer can specify the directory where Visual Studio .NET should store the generated HTML content. If the developer selects Add to Favorites, Visual Studio .NET will bookmark this content in the Favorites menu of Internet Explorer. Press OK to generate the HTML content. Visual Studio immediately creates and displays the documentation using a style sheet. In our example, the user can view the communication from classes Circle, CircleTest and Pointby selecting the desired class in the left-most column. Figure E.6 shows the documentation for class Circle. Note that all member names and summaryelements in Fig. E.2 have been formatted and placed in Members and Description columns, respectively (Fig. E.6). Selecting an item from the Members column opens an HTML page associated with that item. Figure E.7 shows the HTML page associated with method Areaof class Circle. Notice that the returnstags in Fig. E.2 on lines 120 122 mark up the text that is documented as the text placed in the Description column. Fig. E.4 Fig. E.Fig..Fi E4g. E.4E.4Selecting the Build Comment Web Pages from Tools menu. Fig.
Note: In case you are looking for affordable and reliable webhost to host and run your j2ee application check Vision J2ee Web Hosting services.

1338 Generating Documentation in Visual Studio Appendix E Fig. E.3 Fig. E.3Fig. E.FiFi3g. E.3g. E.3CircleTestclass marked up with XML comments. (Part 3 of 3.) XML documentation comments can be placed before a class definition, an interface definition, a constructor or a member (i.e., an instance variable or a reference). The programmer can place a description (i.e., purpose) of the class in element summary. The summaryelement can contain as many lines as necessary to provide a description of the class method, properties, members, etc. As we will see in the next section, any content placed in element summarywill be marked up in a column (labeled Description) of an HTML table. An example of a summary is shown on lines 8 11 of Fig. E.1 to provide a description of class Point. (We also used these tags in Section E.2 when we introduced documentation comments.) Two elements commonly used to describe methods are returns and param. Element returns contains information on the return value, as illustrated by lines 109 112 of Fig. E.1. Method ToStringof Pointreturns a formatted stringthat has the point s x-y coordinate pair. Similarly, the param element contains information on a method s parameters. For example, lines 50 55 of Fig. E.1 associate one paramelement with variable x, and another paramelement with variable y. We use c XML elements to mark up regions of code in our comments. Line 102 of Fig. E.2 shows the use of the celement to specify that Math.PIshould be marked up as code in the resulting documentation. Notice that the c element contains b element that places Math.PIin boldface type on the Web page. The remarks tag enables programmers to document any miscellaneous information or detailed comments. For example, lines 116 119 of Fig. E.2 documents that method Areauses the constant Math.PI. The seetag (lines 103, 118 and 134 of Fig. E.2) is references another class or member (method, constant, property, etc.). Any member can be referenced by using the fully qualifying name (e.g., System.Console.ReadLine). The value tag (lines 67 70 and 88 91 of Fig. E.1 and lines 69 72 of Fig. E.2) is used to describe properties. These comments have no effect on the comment Web pages that can be generated. For more information on these tags and other tags to use, visit the following URI: ms-help://MS.VSCC/MS.MSDNVS/csref/html/ vclrftagsfordocumentationcomments.htm
If you are in need for chaep and reliable webhost to host your website, our recommendation is http web server services.