loading...
Published in:2022-03-31 |

[toc]

一.自动生成文件头部注释和函数注释

参考:
1.https://blog.csdn.net/qq_41613768/article/details/122079718
2.https://blog.csdn.net/qq_42852004/article/details/116135536

1.安装

在vscode的插件中心里搜索安装好用的代码注释插件 —— KoroFileHeader

1648718237548.png

2.设置

点击左下角设置按钮==>选择“设置”>输入“fileheader”>编辑 settings.json文件

3. 编辑setting.json文件*

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
{
// "editor.suggestSelection": "first",
// "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
// "java.jdt.ls.vmargs": "-noverify -Xmx1G -XX:+UseG1GC -XX:+UseStringDeduplication -javaagent:\"C:\\Users\\sunhouxuan\\.vscode\\extensions\\gabrielbb.vscode-lombok-1.0.1\\server\\lombok.jar\"",
// "workbench.colorTheme": "βui - Tomorrow Dark",
// "workbench.startupEditor": "newUntitledFile",
// "files.autoSave": "off",
// 文件头部注释
"fileheader.customMade": {

"Descripttion": "",
"version": "",
"Author": "输入自己姓名",
"Date": "Do not edit",
"LastEditors": "输入自己姓名",
"LastEditTime": "Do not Edit"
},
"fileheader.cursorMode": {
//函数注释
"Descripttion": "",
"Author": "输入自己姓名",
"msg": "",
"param": "",
"return": ""
},
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
"[javascript]": {
"editor.defaultFormatter": "vscode.typescript-language-features"
},
"[less]": {
"editor.defaultFormatter": "HookyQR.beautify"
},
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"files.eol": "\r\n",
"java.jdt.ls.vmargs": "-XX:+UseParallelGC -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -Dsun.zip.disableMemoryMapping=true -Xmx1G -Xms100m -javaagent:\"c:\\Users\\sunhouxuan\\.vscode\\extensions\\gabrielbb.vscode-lombok-1.0.1\\server\\lombok.jar\"",
"[css]": {
"editor.defaultFormatter": "MikeBovenlander.formate"
},
"tabnine.experimentalAutoImports": true,
"[markdown]": {
"editor.defaultFormatter": "yzhang.markdown-all-in-one"
},
"[html]": {
"editor.defaultFormatter": "HookyQR.beautify"
},
"workbench.startupEditor": "none",
"vsicons.dontShowNewVersionMessage": true,
"fileheader.configObj": {


"createFileTime": true,
"language": {
"languagetest": {
"head": "/$$",
"middle": " $ @",
"end": " $/"
}
},
"autoAdd": true,
"autoAddLine": 100,
"autoAlready": true,
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": false
},
"headInsertLine": {
"php": 2,
"sh": 2
},
"beforeAnnotation": {
"文件后缀": "该文件后缀的头部注释之前添加某些内容"
},
"afterAnnotation": {
"文件后缀": "该文件后缀的头部注释之后添加某些内容"
},
"specialOptions": {
"特殊字段": "自定义比如LastEditTime/LastEditors"
},
"switch": {
"newlineAddAnnotation": true
},
"supportAutoLanguage": [],
"prohibitAutoAdd": [
"json"
],
"folderBlacklist": [
"node_modules",
"文件夹禁止自动添加头部注释"
],
"prohibitItemAutoAdd": [
"项目的全称, 整个项目禁止自动添加头部注释, 可以使用快捷键添加"
],
"moveCursor": true,
"dateFormat": "YYYY-MM-DD HH:mm:ss",
"atSymbol": [
"@",
"@"
],
"atSymbolObj": {
"文件后缀": [
"头部注释@符号",
"函数注释@符号"
]
},
"colon": [
": ",
": "
],
"colonObj": {
"文件后缀": [
"头部注释冒号",
"函数注释冒号"
]
},
"filePathColon": "路径分隔符替换",
"showErrorMessage": false,
"writeLog": false,
"wideSame": false,
"wideNum": 13,
"functionWideNum": 0,
"CheckFileChange": false,
"createHeader": true,
"useWorker": false,
"designAddHead": false,
"headDesignName": "random",
"headDesign": false,
"cursorModeInternal": false,
"openFunctionParamsCheck": true,
"functionParamsShape": [
"{",
"}"
],
"functionBlankSpace": 0,
"functionTypeSymbol": "*",
"typeParamOrder": "type param"
},
"security.workspace.trust.untrustedFiles": "open"
// 新添加

// "vetur.format.options.tabSize": 2,
// "vetur.format.options.useTabs": false,
// "vetur.format.defaultFormatter.html": "js-beautify-html",
// // "vetur.format.defaultFormatter.js": "vscode-typ=script",
// "vetur.format.defaultFormatterOptions": {
// "prettyhtml": {
// "printWidth": 100, // No line exceeds 100 characters
// "singleQuote": false // Prefer double quotes over single quotes
// },
// "js-beautify-html": {
// "wrap_attributes": "auto",
// "wrap_attributes_mode": "auto",
// "wrap-line-length": 100,
// "wrapped_attributes_per_line": "multiple",
// "wrapped_attributes_indent": "auto",
// "wrapped_attributes_end": "auto"
// }
// },
}

4. 保存settings.json文件

5.使用

(1)文件头部注释

1
2
快捷键:crtl+alt+i(window),ctrl+cmd+t (mac)
生成样式如下:

(2)文件头部注释

1
2
快捷键:ctrl+alt+t (window), ctrl+alt+t(mac)
函数注释不一定生成在头部,自己把控

二.在Markdown里输入公式

@https://zhuanlan.zhihu.com/p/158156773
这里主要介绍的是Latex用法

1.输入希腊字母

(1)行内公式

$$字样:在 $$之间输入Latex语法实现行内插入公式

(2)行间公式

$$ + 回车,会出现一对 $$的符号,在这一对符号之间输入LaTex语法,即可实现在行间插入公式

(3)希腊字母的Latex用法

1648719077030.png

进阶Markdown

https://zhuanlan.zhihu.com/p/366596107

Prev:
Vscode+Markdown高效配合记笔记
Next:
Phono3py入门
catalog
catalog