Actipro SyntaxEditor .NET Languages Add-on
XML Comment Auto-Complete
The .NET Languages Add-on has a huge number of features related to the editing of XML documentation comments using the C# language.
XML documentation comment IntelliPrompt demonstration (Requires Flash player)
Expansion of ///
Whenever a /// is typed in code, the C# language examines the surrounding code to see if there is a type or member defined.
If so, it auto-completes the XML documentation comment by inserting several lines of comments.
For types the auto-completed comments are as simple as a summary tag.
For members such as methods, the language examines all of the parameters and looks for a return type.
It will automatically add the appropriate param and returns tags for you.
Intelligent Documentation Tag Member Lists
When you type a < while within an XML documentation comment block, a member list displays.
It intelligently populates itself with the appropriate tags for the current caret context.
For example, if you are within a summary tag block, it will not show a remarks tag item since
remarks must be a root level tag. Move outside of the summary tag and type < and you will see remarks listed.
If you are at the root level and already entered a tag block, such as a summary tag block, the member list will not
show the summary tag item in the member list since the .NET Languages Add-on knows that you already added that tag block for
the current type or member.
When editing XML documentation comments for members with parameters, the .NET Languages Add-on will show the proper
param tags with the name property filled in if those param tags do not already exist in the documentation.
Likewise, for members that have return values, the member list will show the appropriate returns or value
tag if it has not already been entered.
Smart XML documentation comment member lists make the process of documenting .NET code so much easier.
Documentation Used in IntelliPrompt
After documentation has been entered for a type or member, it is available for use in the automated IntelliPrompt features
of the .NET Languages Add-on. It will be displayed in member lists, parameter info, and quick info tips.
|