vs code 技巧：使用Doxygen Documentation Generator自动添加注释
安装
安装很简单，直接在插件里搜Doxygen Documentation Generator进行安装
默认配置
在插件的网址中可以看到插件对应效果和配置说明
相关配置可以在vscode配置中选择
也可以修改setting.json(推荐)
如下是示例配置
// The prefix that is used for each comment line except for first and last.
"doxdocgen.c.commentPrefix": " * ",
// Smart text snippet for factory methods/functions.
"doxdocgen.c.factoryMethodText": "Create a {name} object",
// The first line of the comment that gets generated. If empty it won't get generated at all.
"doxdocgen.c.firstLine": "/**",
// Smart text snippet for getters.
"doxdocgen.c.getterText": "Get the {name} object",
// The last line of the comment that gets generated. If empty it won't get generated at all.
"doxdocgen.c.lastLine": " */",
// Smart text snippet for setters.
"doxdocgen.c.setterText": "Set the {name} object",
// Doxygen comment trigger. This character sequence triggers generation of Doxygen comments.
"doxdocgen.c.triggerSequence": "/**",
// Smart text snippet for constructors.
"doxdocgen.cpp.ctorText": "Construct a new {name} object",
// Smart text snippet for destructors.
"doxdocgen.cpp.dtorText": "Destroy the {name} object",
// The template of the template parameter Doxygen line(s) that are generated. If empty it won't get generated at all.
"doxdocgen.cpp.tparamTemplate": "@tparam {param} ",
// File copyright documentation tag. Array of strings will be converted to one line per element. Can template {year}.
"doxdocgen.file.copyrightTag": [
"@copyright Copyright (c) {year}"
],
// Additional file documentation. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.
"doxdocgen.file.customTag": [],
// The order to use for the file comment. Values can be used multiple times. Valid values are shown in default setting.
"doxdocgen.file.fileOrder": [
"file",
"author",
"brief",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
],
// The template for the file parameter in Doxygen.
"doxdocgen.file.fileTemplate": "@file {name}",
// Version number for the file.
"doxdocgen.file.versionTag": "@version 0.1",
// Set the e-mail address of the author. Replaces {email}.
"doxdocgen.generic.authorEmail": "you@domain.com",
// Set the name of the author. Replaces {author}.
"doxdocgen.generic.authorName": "your name",
// Set the style of the author tag and your name. Can template {author} and {email}.
"doxdocgen.generic.authorTag": "@author {author} ({email})",
// If this is enabled a bool return value will be split into true and false return param.
"doxdocgen.generic.boolReturnsTrueFalse": true,
// The template of the brief Doxygen line that is generated. If empty it won't get generated at all.
"doxdocgen.generic.briefTemplate": "@brief {text}",
// The format to use for the date.
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
// The template for the date parameter in Doxygen.
"doxdocgen.generic.dateTemplate": "@date {date}",
// Decide if you want to get smart text for certain commands.
"doxdocgen.generic.generateSmartText": true,
// Whether include type information at return.
"doxdocgen.generic.includeTypeAtReturn": true,
// How many lines the plugin should look for to find the end of the declaration. Please be aware that setting this value too low could improve the speed of comment generation by a very slim margin but the plugin also may not correctly detect all declarations or definitions anymore.
"doxdocgen.generic.linesToGet": 20,
// The order to use for the comment generation. Values can be used multiple times. Valid values are shown in default setting.
"doxdocgen.generic.order": [
"brief",
"empty",
"tparam",
"param",
"return",
"custom",
"version",
"author",
"date",
"copyright"
],
// Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.
"doxdocgen.generic.customTags": [],
// The template of the param Doxygen line(s) that are generated. If empty it won't get generated at all.
"doxdocgen.generic.paramTemplate": "@param {param} ",
// The template of the return Doxygen line that is generated. If empty it won't get generated at all.
"doxdocgen.generic.returnTemplate": "@return {type} ",
// Decide if the values put into {name} should be split according to their casing.
"doxdocgen.generic.splitCasingSmartText": true,
// Array of keywords that should be removed from the input prior to parsing.
"doxdocgen.generic.filteredKeywords": [],
// Substitute {author} with git config --get user.name.
"doxdocgen.generic.useGitUserName": false,
// Substitute {email} with git config --get user.email.
"doxdocgen.generic.useGitUserEmail": false,
// Provide intellisense and snippet for doxygen commands
"doxdocgen.generic.commandSuggestion": true,
// Add `\\` in doxygen command suggestion for better readbility (need to enable commandSuggestion)
"doxdocgen.generic.commandSuggestionAddPrefix": false
效果如下：
/**
* @file XXX.c
* @author your name (you@domain.com)
* @brief
* @version 0.1
* @date 2023-01-11
*
* @copyright Copyright (c) 2023
*
*/
/**
* @brief
*
* @param addr
* @param data
* @param length
* @return char
* @version 0.1
* @author your name (you@domain.com)
* @date 2023-01-11
* @copyright Copyright (c) 2023
*/
char test_fun(uint8_t addr, uint8_t *data, uint8_t length)
{
}
自用配置分享
"doxdocgen.file.copyrightTag": [
"@copyright Copyright (c) {year} XXX ",
"For study and research only, no reprinting",
],
"doxdocgen.file.customTag": [
"************************************************************************",
],
"doxdocgen.file.fileOrder": [
"custom",
"empty",
"file",
"author",
"brief",
"empty",
"custom",
"copyright",
"custom"
],
"doxdocgen.generic.authorEmail": "XXX@abc.com",
"doxdocgen.generic.authorName": "XXX",
"doxdocgen.generic.authorTag": "@author {author} ({email})",
"doxdocgen.generic.order": [
"custom",
"brief",
"empty",
"param",
"empty",
"return",
"custom",
],
"doxdocgen.generic.customTags": [
"************************************************************************"
],
"doxdocgen.generic.paramTemplate": "@param[in] {indent:8}{param} {indent:8} Comment",
"doxdocgen.generic.returnTemplate": "@return ",
效果如下：
/**
* ************************************************************************
*
* @file XXX.c
* @author XXX (XXX@XXX.com)
* @brief
*
* ************************************************************************
* @copyright Copyright (c) 2023 XXX
* For study and research only, no reprinting
* ************************************************************************
*/
#include <stdio.h>
/**
* ************************************************************************
* @brief
*
* @param[in] addr Comment
* @param[in] data Comment
* @param[in] length Comment
*
* @return
* ************************************************************************
*/
char test_fun(uint8_t addr, uint8_t *data, uint8_t length)
{
}
其他
另外推荐一个插件叫Auto Comment Blocks，能自动补全下注释，可以搭配者来用
