简介
可以为程序文件和函数生成注释
修改配置文件
默认的文件注释模板一般不符合个性化的需求,如果要自定义文件注释模板,则需要修改配置文件。
按下快捷键ctrl+shit+p,调出快速导航窗口,在编辑框中输入json,如下所示:

- “Preferences:Open User Settings(JSON)”:json格式的配置文件,对当前用户的所有工作区有效
- “Preferences:Open Workspace Settings(JSON)”:json格式的配置文件,只对当前工作区有效
我们选择 “Preferences:Open User Settings(JSON)”,单击打开JSON文件,并将如下内容粘贴到JSON文件中:
"doxdocgen.file.fileOrder": [
"file",
"version",
"date",
"brief",
"empty",
"custom",
"empty",
"empty",
"copyright"
],
"doxdocgen.file.versionTag": "@version A001",
"doxdocgen.file.customTag": [
"@par 版本记录",
"",
"修改日期 | 版本 | 修改人 |修改内容",
"-|-|-|-",
"{date}|A001|xxx|初始版本"
],
"doxdocgen.file.copyrightTag": [
"@copyright 2004-{year} (C) Copyright xxx Technology Inc."
],
JSON内容如下:

验证效果
文件注释
在文件的第一行输入/**然后点击enter键,生成的文件注释如下:

注释的每一行和配置文件中"doxdocgen.file.fileOrder"是一 一对应的

函数注释
函数注释模板不需要修改,直接用默认的即可。
在需要添加注释的函数上一行输入/**然后按enter键即可为函数添加注释,效果如下所示:

配置选项
{
// 用于每行注释(首行和尾行除外)的前缀。
"doxdocgen.c.commentPrefix": " * ",
// 工厂方法/函数的智能文本片段。
"doxdocgen.c.factoryMethodText": "Create a {name} object",
// 生成注释的第一行。如果为空,则不会生成。
"doxdocgen.c.firstLine": "/**",
// 获取器的智能文本片段。
"doxdocgen.c.getterText": "Get the {name} object",
// 生成注释的最后一行。如果为空,则不会生成。
"doxdocgen.c.lastLine": " */",
// 设置器的智能文本片段。
"doxdocgen.c.setterText": "Set the {name} object",
// 触发 Doxygen 注释生成的字符序列。
"doxdocgen.c.triggerSequence": "/**",
// 构造函数的智能文本片段。
"doxdocgen.cpp.ctorText": "Construct a new {name} object",
// 析构函数的智能文本片段。
"doxdocgen.cpp.dtorText": "Destroy the {name} object",
// 生成的模板参数 Doxygen 行的模板。如果为空,则不会生成。
"doxdocgen.cpp.tparamTemplate": "@tparam {param} ",
// 文件版权文档标签。字符串数组将被转换为每个元素一行。可以使用 {year} 模板。
"doxdocgen.file.copyrightTag": [
"@copyright Copyright (c) {year}"
],
// 额外的文件文档。每个标签占一行,将被添加。可以使用 {year}、{date}、{author}、{email} 和 {file} 模板。需要指定前缀。
"doxdocgen.file.customTag": [],
// 文件注释的顺序。值可以多次使用。有效值如默认设置所示。
"doxdocgen.file.fileOrder": [
"file",
"author",
"brief",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
],
// Doxygen 文件参数的模板。
"doxdocgen.file.fileTemplate": "@file {name}",
// 文件的版本号。
"doxdocgen.file.versionTag": "@version 0.1",
// 设置作者的电子邮件地址。替换 {email}。
"doxdocgen.generic.authorEmail": "you@domain.com",
// 设置作者的名称。替换 {author}。
"doxdocgen.generic.authorName": "your name",
// 设置作者标签的样式和你的名字。可以使用 {author} 和 {email} 模板。
"doxdocgen.generic.authorTag": "@author {author} ({email})",
// 如果启用,布尔返回值将被拆分为 true 和 false 返回参数。
"doxdocgen.generic.boolReturnsTrueFalse": true,
// 生成的简要 Doxygen 行的模板。如果为空,则不会生成。
"doxdocgen.generic.briefTemplate": "@brief {text}",
// 日期的格式。
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
// Doxygen 日期参数的模板。
"doxdocgen.generic.dateTemplate": "@date {date}",
// 决定是否为某些命令生成智能文本。
"doxdocgen.generic.generateSmartText": true,
// 是否在返回值中包含类型信息。
"doxdocgen.generic.includeTypeAtReturn": true,
// 插件应查找多少行以确定声明的结束。请注意,将此值设置得过低可能会略微提高注释生成的速度,但插件可能无法正确检测所有声明或定义。
"doxdocgen.generic.linesToGet": 20,
// 注释生成的顺序。值可以多次使用。有效值如默认设置所示。
"doxdocgen.generic.order": [
"brief",
"empty",
"tparam",
"param",
"return",
"custom",
"version",
"author",
"date",
"copyright"
],
// 添加到通用顺序的自定义标签。每个标签占一行,将被添加。可以使用 {year}、{date}、{author}、{email} 和 {file} 模板。需要指定前缀。
"doxdocgen.generic.customTags": [],
// 生成的参数 Doxygen 行的模板。如果为空,则不会生成。
"doxdocgen.generic.paramTemplate": "@param {param} ",
// 生成的返回 Doxygen 行的模板。如果为空,则不会生成。
"doxdocgen.generic.returnTemplate": "@return {type} ",
// 决定是否根据大小写拆分 {name} 中的值。
"doxdocgen.generic.splitCasingSmartText": true,
// 在解析之前应从输入中移除的关键字数组。
"doxdocgen.generic.filteredKeywords": [],
// 使用 git config --get user.name 替换 {author}。
"doxdocgen.generic.useGitUserName": false,
// 使用 git config --get user.email 替换 {email}。
"doxdocgen.generic.useGitUserEmail": false,
// 提供 Doxygen 命令的智能感知和代码片段。
"doxdocgen.generic.commandSuggestion": true,
// 在 Doxygen 命令建议中添加 \\ 以提高可读性(需要启用 commandSuggestion)。
"doxdocgen.generic.commandSuggestionAddPrefix": false,
}
337



被折叠的 条评论
为什么被折叠?



