1338 Generating Documentation in Visual Studio Appendix E (Free 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.