Game Development Reference
In-Depth Information
format. While this method works and is convenient because of the IDE integration,
NDoc produces much better documentation in a variety of formats.
For starters, launch the NDoc application and select the New from Visual Studio
Solution option from the toolbar at the top of the window, as shown in Figure
11.6. At this stage, we must let NDoc know which assemblies have commenting
enabled and should have corresponding documentation generated for them. This
step could be done manually, although referencing the assemblies automatically
from your project solution is much easier and faster.
Figure 11.6
Toolbar option to import assemblies.
Selecting the toolbar option should bring up a dialog that asks you to select the
solution configuration of the project to use. I typically use debug mode, but it gen-
erally doesn't matter when you stick with default solution configurations. This
dialog should look like the one shown in Figure 11.7.
Figure 11.7
Dialog asking to select the solution
configuration to use.
After the appropriate solution configuration to use has been selected, the NDoc
window should populate with all the referenced assemblies for the solution. There
are a number of formatting and configuration settings that can be modified for an
NDoc project, but for the most part, we will use the default values for the purpose
of this discussion. You should end up with a dialog similar to the one shown in
Figure 11.8. The final step (yes, it is that easy) is to build the documentation by
clicking on the Build Documentation button in the toolbar, or by using the
Ctrl+Shift+B shortcut.
Search Nedrilad ::

Custom Search