Documentation
Documentation A great feature of Visual Studio is the Code Comment Web Report. Visual Studio will examine a solution and create a cross-referenced Web documenta professional-looking HTML document, might I addautomatically for the benefit of the developers or consumers of your source code. (Figure 1.12 shows the Code Comment Web Report focused on the Form1 class from the EmptyForm project.) Figure 1.12. Public members of EmptyForm.Form1 shown in an automatically generated Code Comment Web Report. Note C# supports the automatic inclusion of code comments. If you add an extra hash mark, using three hash marks (///) instead of two, C# will add those comments to your Code Comment Web Report. Currently the code comment feature isn't supported in Visual Basic .NET, but we can hope. In anticipation of your comments being included in Web documentation, it might be a good time to start practicing writing complete sentence comments. Create HTML documentation for your solution by choosing Tools, Build Comment Web Pages. Click OK and the rest is done automatically.  |
| | |
Team-Fly  |
| Top |
