Appendix E Generating Documentation in Visual Studio 1347 (Freelance web design)
Appendix E Generating Documentation in Visual Studio 1347 SUMMARY Programmers should document specific information on a class, such as the class s role in a system, the functionality that each method provides for the class and the purpose of each class variable. Documentation helps all programmers understand how classes can interoperate, as well as facilitate modification, use and extension of each class. Visual Studio .NET provides the XML documentation tool. This tool converts key pieces of information in the code such as the class s members, the hierarchy to which the class belongs and any other general remarks the programmer wishes to document to HTML or XML format. The programmer specifies the general remarks to be documented by placing them in special regions in the code, called XML documentation comments. The documentation-generation tool recognizes only single-line comments that begin with three forward slashes (///). The compiler does not translate documentation comments to MSIL (Microsoft Intermediate Language). The programmer can place a description (i.e., purpose) of the class in between summary tags. Element returnscontains information on the return value. Similarly, the param element contains information on a method s parameters. Element c marked up regions of code in the comments. The remarks tag enables programmers to document any miscellaneous information or detailed comments relating to a member. The see tag is used to reference another member (method, constant, property, etc.).
We recommend high quality webhost to host and run your jsp application: christian web host services.