Auto Comments

LumiCode lets you merge comments from your code directly into your diagrams and reports.

Your Visual Studio C# compiler can produce XML Documentation Comments from the comments in your code. Making those comments available to LumiCode requires two steps:

1. In the build options for your Visual Studio project, check XML Documentation File and specify a path for the file.
2. Add the comment files to LumiCode.

Adding comment files

1. Under the Project menu, click Comment Files. You will see the Comment Files dialog box.

2. Click the Add button and navigate to the folder where your XML comment files are located (from your Visual Studio Project settings).

3. Select the files you want merged, and then click Open.

4. Click OK to close the Comment Files dialog box.

5. The comments from your code can now be added to Class Diagrams, Call Diagrams, Sequence Diagrams, and Class Reports.