Game Development Reference
In-Depth Information
As you can see in the above code example, we have documented the source code
for the SaveApplicationSettings method, and now that we have done so, it is avail-
able for IntelliSense. Now whenever you start typing out the name of the method,
IntelliSense will fire up and give you information about the method and the para-
meters it expects. This is illustrated in Figure 11.4.
Figure 11.4 Example of on-the-fly IntelliSense documentation.
Aside from on-the-fly IntelliSense, you can also mouse over a documented method
or type and see the documentation overview for it. This is depicted in Figure 11.5.
Figure 11.5 Example of IntelliSense type overview.
Generating the Documentation
IntelliSense information is a handy tool, but using XML documentation for
IntelliSense alone is a waste compared to the wonderful documentation that can
be generated from the XML documentation file. There are two main ways to gen-
erate your documentation, but the NDoc approach will be the evangelized method
in this chapter.
The first method, and the one this chapter will not cover, is the built-in docu-
mentation tool in Visual Studio .NET. Under the Tools menu is an option titled
Build Comment Web Pages..., which will produce help files in the Visual Studio .NET
Search Nedrilad ::

Custom Search