You can create a series of Web pages, called a code comment Web report, that allow you to browse the code structure within files in your current project or solution, such as objects and interfaces defined in a project, and members. Using special code comment syntax, you can also include notes or other information. By default, code comment Web pages are stored in a directory called CodeCommentReport, and this directory is placed in the directory containing the solution file.

Note   Currently, only C# supports the code comment syntax required for code comment Web reports. Additional languages might also support code comment syntax at a later date.

The home page for the code comment Web report lists summary information for the solution. This page is created regardless of whether or not you choose to build a Web report for a solution or just selected projects. Selecting a project from the home page takes you to a summary page for the project and displays a navigation pane. You can then browse the code structure for the project by selecting links from either the project summary page or from the navigation pane. The navigation pane lists all the namespaces within the project. These namespaces include classes, structures, interfaces, enumerators, and delegates.

See Also

Adding Comments in C# Code | Viewing Code Structure with Comments | Build Comment Web Pages Dialog Box | Tags for Documentation Comments | Creating Code Reports