Go to Tools - VSdocman menu or press VSdocman button on standard toolbar. VSdocman dialog appears, select Project Properties pane. Select Output - Constants and Enumerations page.

Constants and enumerations value display

Specifies the way how the value of a constant or an enumeration will be displayed in the generated syntax section. For example, you have the following constant defined in your source code:


public const int CONST1 = 2 + 2;

There are three options for displaying this value.



Computed value

VSdocman tries to evaluate the value expression. In our case, the result will be "4". If the expression contains another constant or a member, e.g. ANOTHER_CONST * 3, the evaluation fails and the result contains the original code. While this is a preferred method, remember that the evaluation is quite time consuming task. If you have hundreds of constants or enum items with explicit values, it can take several minutes to complete.

No value

VSdocman will not display any value in the constant declaration. In our case, "public const int CONST1;". This method is fast.

Original expression from source code

VSdocman displays the value exactly as it is defined in the source code. This method is fast. Note that the value is language specific but it will be displayed for all generated languages in the Syntax section. While strings and decimals are same in C# and VB, if the value is in hexa format, the 0xFF C# format is invalid in VB syntax.

This method may be also useful, if the constant value is a non-visible character, e.g. backspace:

public const char BACKSPACE = (char)0x8;

The computed value wouldn't be visible in the generated documentation. Using this option will show what the value is.

Note, most output formats don't display the values of enum items. It is possible to customize the output templates so that they produce the enum values.

Enumeration items sort order

Specifies in which order the enum items will be listed in generated documentation.

See Also