Generate documentation comments for Visual Studio Code.
Type "///", it auto-generates an XML documentation comment like this:
/// <summary>
///
/// </summary>
Type "/**" and push Enter, it auto-generates an documentation comment like this:
/**
* @brief
* @note
* @param baudRate:
* @retval None
*/
The menu under File > Preferences (Code > Preferences on Mac) provides entries to configure user and workspace settings. You are provided with a list of Default Settings. Copy any setting that you want to change to the related settings.json
file.
{
// Press the Enter key to activate a command (Default: false)
"docomment.activateOnEnter": true,
// Insert spaces when pressing Tab.
"editor.insertSpaces": true,
// The number of spaces a tab is equal to.
"editor.tabSize": 4
}
- Install Visual Studio Code 1.8.0 or higher
- Launch Code
- From the extension view
Ctrl
-Shift
-X
(Windows, Linux) orCmd
-Shift
-X
(macOS) - Search and Choose the extension
C-family Documentation Comments
- Reload Visual Studio Code
- C#
- C++
- C
This extension is licensed under the MIT License.