Generating and visualizing C# documentation

Documentation generation

The NDoc tool, which can be downloaded at http//sourceforge.net/projects/ndoc/, can be launched on any component for which code has been generated and compiled.

This feature uses the "CsCummary" and "CsRemarks" type notes which exist on the model's classes, attributes, associations and operations.
You can choose via a parameter whether "description" type notes should be processed in the same way as "csDoc" notes or not.

Figure 49. Generating C# documentation

Steps:

1. Right-click on the "BankApp" Component in the explorer.

2. Run the "C# Developer/Documentation generation" command from the context menu that appears.

The window shown in Figure 50 then appears.

Figure 50. Window used to define the documentation you are about to generate

Visualizing generated C# documentation

After generation, C# documentation is immediately opened (Figure 51).

Figure 51. C# documentation generated on the "BankAccount" class