Do you like the extension? Then please donate to help maintain it (click the first button)
Automatic doxygen comments creation for functions, headers and all other members. The comments formats can be completely customized and updated after a function changed.
Visual Studio Marketplace: DoxygenComments.
Or in Visual Studio -> Extensions -> Doxygen Comments
The following formats are the default formats, but the can be customized.
/*****************************************************************//**
* \file sampleClass.h
* \brief
*
* \author Finn
* \date April 2020
***********************************************************************//**
* Set the sample class name.
*
* \param name The name for the sample class
* \return a sample return value
*/Type '/**' for single line comments. After the comment is created, press enter or tab to generate the doxygen comment.
To skip the single line format, use '/*!'.
Header can be created by writing '/**' in the first file line, and all other, directly before the wished member.
- Function: Automatic paramets and return values
- Header: Automatic file, date and author
The plugin settings are under Tools -> Options -> Doxygen.
In the pages Header, Function and Default are the customizable formats.
You can use all the listed variables. The \param will be multiplied to the number of parameters of the function
and the \return attribute will only be shown without a void return type.
You can replace attributes like \param or \return with everything else (for example: @param),
if you use the $PARAMS and $RETURN variables in the same line.
To use the $ character as plain text in your comment you can escape ith with \ (e.g. \$id will be shown as $id in the comment)
If you want you can add custom attributes like \license to always generate a licence in a header comment.
If you want to update a function documentation after the function was changed, just place the cursor in the function or documentation to update and then you...
- ... can use the menu
Tools/Update Doxygen comment - ... or use the shortcut (default
Control+Shift+R).
After that, the plugin may show a dialog, but only if there are any unresolved issues.
In this dialog you just choose which parameters are the old versions of ones shown in the left
column, or select New parameter if you added the paramter.
To change the shortcut, just go into your settings Tools/Options/Envrionment/Keyboard
and search for doxygen.
If you want to contirbute to this plugin and add a nice feature or fix a bug, feel free to make a pull request in my repository.
If I have time, or if you want to help, the following features would be nice to implement:
- IntelliSense Quick Info for doxygen style
- Share the customized formats in the git repo
This is a fork of dragospop/CppDoxyComplete, but is for VS2019, customizable and has the option to update comments.