C-family Documentation Comments

Generate XML/Doxygen documentation comments for C#, C, and C++ in Visual Studio Code.

Note: This is a continuation of the original extension, now maintained by the original author under a new publisher ID.

Usage

Flexible Comment Styles

NEW: You can now use both comment styles in any C-family file, regardless of the file extension! The extension automatically detects which style you're using:

Type "///", it auto-generates an XML documentation comment like this:

/// <summary>
/// 
/// </summary>

Type "/**" and push Enter, it auto-generates a Doxygen documentation comment like this:

/** 
 * @brief  
 * @note   
 * @param  baudRate: 
 * @retval None
 */

✨ Use /// in C++ files or /** in C# files - the extension will generate the appropriate documentation format based on what you type!

Configuration

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.

settings.json

{
	// 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
}

Installation

1. Install Visual Studio Code 1.8.0 or higher
2. Launch Code
3. From the extension view Ctrl-Shift-X (Windows, Linux) or Cmd-Shift-X (macOS)
4. Search and Choose the extension C-family Documentation Comments
5. Reload Visual Studio Code

Supported Languages

• C#
• C++
• C

Contributors

• @alexermolov

License

This extension is licensed under the MIT License.