Appendix E (Web and email hosting) Generating Documentation in Visual Studio 1339
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.