VSCode 使用 snippets 插入代码注释

发表于 更新于 分类于 阅读次数：

突然发现用 snippets 写注释也非常好用啊，比如写 Fortran 的 function 或 subroutine 的头部注释：

1
2
3
4
5
6
7
8
9
10
11
!-----------------------------------------------------------------------------
! name      : symSchur2
! remark    : get Schur decomposition for 2x2 matrix
!
! version   : 1.0
! date      : 2023-09-06 13:34:25
! author    : XXX
!-----------------------------------------------------------------------------
subroutine symSchur2(A,c,s)
...
end subroutine symSchur2

直接在 Fortran 对应的 snippets 设置文件 FortranFreeForm.json 中加入如下片段：

1
2
3
4
5
6
7
8
9
10
11
12
13
"Head comments for subroutines":{
		"prefix": "hc",
		"body": [
			"!-----------------------------------------------------------------------------",
			"! name      : $1",
			"! remark    : $2",
			"!",
			"! version   : 1.0",
			"! date      : $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE  $CURRENT_HOUR:$CURRENT_MINUTE:$CURRENT_SECOND",
			"! author    : XXX",
			"!-----------------------------------------------------------------------------"
		]
	}

其中，变量 $1 $2 在插入 snippets 时会自动要求你插入新的内容。时间部分可以用 VSCode 内置的变量添加。