Doxygen documentation
Doxygen-style comments can be placed across the source code and used for generating fully-fledged documentation in various formats.
ReSharper includes the information from doxygen into the Quick Documentation popup Control+Q:
Viewing doxygen documentation
Information from documentation comments is included in Quick Documentation popup in addition to the type information. To invoke the documentation popup:
Place the caret at the desired symbol or at the
@paramcommand of the doxygen comment.Press Control+Q.
If function parameters are documented separately from the function description, ReSharper will merge all the comments and show you the full function’s signature documentation (the same way as doxygen does when generating the output) .
Creating doxygen comments
To create a doxygen comment from scratch:
Type one of the following symbols:
///,//!,/**or/*!and press Enter.You will get a stub to fill with the documentation text:
You can also use the Document entity (Control+/) context action. If necessary, you can customize the comment stub by editing the doc live template that ReSharper uses for generation.
Reliable rename
While renaming a function or its parameters, the documentation comments need to be updated accordingly. In case of the Rename refactoring F2, ReSharper updates documentation comments along with other references.
Before:
After:
