In addition to specifying member types, accessibility and files, VSdocman allows to include or exclude documented members according to their name, declaration and attributes. You can define any number of such filters using regular expressions.
Go to Tools - VSdocman menu or press VSdocman button on standard toolbar. VSdocman dialog appears, select Project Properties pane. Set Code Members - Regex Filters page.
The page contains a list of all regex filters. There are two kinds of regex filters - include and exclude. A member passes the filters and it will be included in documentation if:
1.at least one include filter condition is true
2.none of the exclude filters is true
If there is no include filter, "include all" is used by default.
Editing Regex Filters
You can add or edit a regex filter using Add and Edit buttons. In both cases, the same regex editor opens.
Filter nameYou can define a name for the filter for better orientation. It is not necessary. If no name is defined, VSdocman uses automatically generated name based on other filter properties. Filter typeSpecifies whether the filter is include or exclude. Filter applies toThe regex filter matches the regex expression with three kinds of input: 1.Member full name - which includes namespace and class names separated by dots. Parameters if any are NOT part of this name. 2.Member complete signature including attributes - which includes attributes if any, and a complete member signature with attributes and a return value. This input allows for more flexibility but requires more complex regex pattern. 3.Member complete signature with attributes and XML comments - which includes XML comments if any, attributes if any, and a complete member signature with attributes and a return value. This input allows for more flexibility but requires more complex regex pattern. Regular expressionDefines a regex pattern used for matching. The format is very simple. It is a standard regular expression that the input must match. You can use full regex syntax supported by .NET framework. In addition, if you want to allow any value, you don't need to use .* but you can leave the field blank. Don't forget to escape special characters like dot, comma or parentheses with \. If the input contains newlines, then .* stops on the next newline. To search over newlines, use (.|\n)* instead. TestThe Test button opens the quick regex tester where you can immediately see whether your pattern works as expected. You can even edit the pattern and apply it to the edited filter.
|
