DoxyGen Documentation Generatorc
这个VsCode插件可以设置C/C++的doxygen格式自动填充,本文只介绍C语言的json文件配置。
触发方式
"doxdocgen.c.triggerSequence": "/**",
"doxdocgen.generic.linesToGet": 50,
首行、尾行和非首行尾行前缀
"doxdocgen.c.firstLine": "/**",
"doxdocgen.c.lastLine": " */",
"doxdocgen.c.commentPrefix": " * ",
"doxdocgen.c.firstLine": "/*@",
"doxdocgen.c.lastLine": "@*/",
"doxdocgen.c.commentPrefix": " @ ",
文件头注释及排序
"doxdocgen.file.fileOrder": [
"file",
"brief",
"author",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
],
"doxdocgen.file.fileTemplate": "@file {name}",
"doxdocgen.file.copyrightTag": [
"@copyright Copyright (c) {year} TEST"
],
"doxdocgen.file.versionTag": "@version 2.0",
"doxdocgen.generic.authorEmail": "[email protected]",
"doxdocgen.generic.authorName": "test",
"doxdocgen.generic.authorTag": "@author {author} ({email})",
"doxdocgen.file.customTag": [
"@par 修改日志:",
"",
"Date | Version | Author | Description",
"{date} | 2.0 | test | 内容",
" | |
---|
",
]
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
"doxdocgen.generic.dateTemplate": "@date{date}",
函数注释
"doxdocgen.generic.briefTemplate": "@brief{indent:10}{text}【描述】",
"doxdocgen.generic.paramTemplate": "@param[in/out]{indent:15}{param}{indent:20}【参数注释】",
"doxdocgen.generic.returnTemplate": "@return {type}{indent:20}【返回值注释】",
"doxdocgen.generic.customTags": ["@warning{indent:10}【不可重入,阻塞等警告】", "@note{indent:10}【重大修改】"],
"doxdocgen.generic.includeTypeAtReturn": true,
"doxdocgen.generic.order":["brief", "param", "return", "empty", "custom"],
float Test(int a, int b)
{
}
其他
- bool返回值处理
"doxdocgen.generic.boolReturnsTrueFalse": false,
bool Init_ModuleA(Module* me){}
"doxdocgen.generic.boolReturnsTrueFalse": true,
bool Init_ModuleA(Module* me){}
- Get,Set,Creat函数
"doxdocgen.generic.splitCasingSmartText": true,
"doxdocgen.c.setterText": "Set {name}",
"doxdocgen.c.getterText": "Get {name}",
"doxdocgen.c.factoryMethodText": "Create {name}",
float GetObjectData(int a, int b)
{
}
- 关键字过滤
"doxdocgen.generic.filteredKeywords": [
"me",
],
int Test(int me, int a, int b)
{
}
- 命令建议
"doxdocgen.generic.commandSuggestion": true,
"doxdocgen.generic.commandSuggestionAddPrefix": true,
样例
附一份我在用的C语言注释,粘到json即可
"doxdocgen.c.triggerSequence": "/**",
"doxdocgen.c.firstLine": "/******************************************************************************",
"doxdocgen.c.commentPrefix": "*",
"doxdocgen.c.lastLine": "******************************************************************************/",
"doxdocgen.generic.linesToGet": 50,
"doxdocgen.file.fileOrder": [
"file",
"brief",
"author",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
],
"doxdocgen.file.fileTemplate": "@file{indent:10}{name}",
"doxdocgen.generic.authorEmail": "[email protected]",
"doxdocgen.generic.authorName": "苏打豆",
"doxdocgen.generic.authorTag": "@author{indent:10}{author}",
"doxdocgen.file.versionTag": "@version{indent:10}1.0",
"doxdocgen.generic.dateFormat": "YYYY.MM.DD",
"doxdocgen.generic.dateTemplate": "@date{indent:10}{date}",
"doxdocgen.file.copyrightTag": [
"@copyright{indent:12}Copyright (c) 2011 ABC.Co.Ltd. All rights reserved."
],
"doxdocgen.file.customTag": [
"@par 修改日志:",
"",
"Date | Version | Author | Description",
"{date} | 【版本号】 | 【作者】 | 【日志】",
" | |
---|
",
],
"doxdocgen.generic.order":[
"brief",
"param",
"return",
"empty",
"custom"],
"doxdocgen.generic.briefTemplate": "@brief{indent:10}{text}【描述】",
"doxdocgen.generic.splitCasingSmartText": true,
"doxdocgen.c.setterText": "Set {name}",
"doxdocgen.c.getterText": "Get {name}",
"doxdocgen.c.factoryMethodText": "Create {name}",
"doxdocgen.generic.paramTemplate": "@param[in/out]{indent:15}{param}{indent:20}【参数注释】",
"doxdocgen.generic.filteredKeywords": [
"me"],
"doxdocgen.generic.returnTemplate": "@return {type}{indent:20}【返回值注释】",
"doxdocgen.generic.includeTypeAtReturn": true,
"doxdocgen.generic.boolReturnsTrueFalse": false,
"doxdocgen.generic.customTags": ["@warning{indent:10}【不可重入,阻塞等警告】", "@note{indent:10}【重大修改】"],
"doxdocgen.generic.commandSuggestion": true,
"doxdocgen.generic.commandSuggestionAddPrefix": true,