1)选择安装扩展:左下角齿轮,扩展,搜索“doxdocgen”,
2)安装后,左侧插件上点邮件,菜单中选“扩展设置”,右侧见到设置页面,就是可以配置各个部分的参数。可以直接点击“在setting.json编辑”,直接打开setting.json文件,根对象下(一级花括号)添加相关属性如下
"doxdocgen.file.copyrightTag": [
"@copyright Copyright (c) {year} XX通信公司"
],
"doxdocgen.file.customTag": [
"@par 修改日志:",
"<table>",
"<tr><th>Date <th>Version <th>Author <th>Description",
"<tr><td>{date} <td>1.0 <td>wangh <td>内容",
"</table>",
],
"doxdocgen.file.fileOrder": [
"file",
"brief",
"author",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
],
"doxdocgen.file.fileTemplate": "@file {name}",
"doxdocgen.file.versionTag": "@version 1.0",
"doxdocgen.generic.authorEmail": "wanghuan3037@fiberhome.com",
"doxdocgen.generic.authorName": "wangh",
"doxdocgen.generic.authorTag": "@author {author} ({email})",
"doxdocgen.generic.order": [
"brief",
"tparam",
"param",
"return"
],
"doxdocgen.generic.paramTemplate": "@param{indent:8}{param}{indent:25}My Param doc",
"doxdocgen.generic.returnTemplate": "@return {type} ",
"doxdocgen.generic.splitCasingSmartText": true
3)测试一下,在文件开头输入 /** 回车,可以自动输入注释,
在函数上边输入/** 回车,可以自动输入注释,