1346 Generating Documentation in Visual Studio Appendix E (Web site)

1346 Generating Documentation in Visual Studio Appendix E 219

220 Entry point of application. 221 222 223 In this application all command-line arguments 224 are ignored. 225 226
227 Optional arguments to Main. 228 229 230 231 232 Fig. E.8 Fig. E.Fig.Fi E.8g. E.88XML documentation generated by Visual Studio .NET. (Part 6 of 6.) Fig. E. Notice that only class members are included in the generated XML file. Each class member has a member element which includes all XML comments for that member. For example, lines 50 69 define a memberelement that contains information on the two-argument Pointconstructor. The name attribute of a membertag is a stringthat contains information about the name and type of the member. The type is specified by a capital letter: M stands for method, P for property (or indexer), E for event and T for type (i.e, class). For a complete listing of these abbreviations, select Help > Index, then locate the topic processing XML files in C#. In Fig. E.8, line 51 contains the value of the name attribute and contains an Mas the first letter, indicating that line 51 declares a method (recall that a constructor is a specialized method). A colon follows, after which the full name of the method is shown. For this example, it is CircleTest. Point.#ctor(System.Int32,System.Int32). Because this is a constructor, the string #ctor is used in the fully qualified name. This constructor takes two int arguments the parentheses after the name of each member specify that member s type. TERMINOLOGY ///(documentation comment) nameattribute of memberelement Build Comment Web Pages paraelement celement paramelement class definition parameters constructor property creating XML documentation reference directory remarkselement documentation return value Documentation column returnselement HTML seeelement instance variable source code interface definition style sheet member summaryelement memberelement tag Members column valueelement method declaration XML documentation comment
In case you need quality webspace to host and run your web applications, try our personal web hosting services.

Leave a Reply