VisualStudioCode スニペットでDoxygenのテンプレを作ろう

DoxygenのコメントをVSコードのスニペットで楽しよう

初めに

Doxygenを使うにあたって、コメントの全部を手打ちするのはだるいと思い、定型句を簡単に入力できないかと検討。
そしたらVSCODEのスニペットで簡単入力ができることがわかり、Doxygenの定型句をメモとして残そうと思った次第。

対象言語：C言語

ファイルコメントヘッダ

"CfileComment": {
	"prefix": "ficommheader",
	"body": "/**\n* @file $1ファイル名.c\n* @brief $2簡単な説明\n* @details $3詳細な説明\n*/",
	"description": "ファイルコメントヘッダ"
}

関数コメントヘッダ

"Print to console": {
 	"prefix": "funccomm",
 	"body":[
		 	 "/**",
	 	 	  "* @brief $1簡単な説明（～する関数）",
	 	 	  "* @param[in] $2a(引数名) 引数の説明",
	 	 	  "* @param[out] $3b(引数名) 引数の説明",
	 	 	  "* @return bool $4戻り値の説明",
	 	 	  "* @details $5詳細な説",
	 	 	  "*/\n"
		],
 	"description": "関数コメントヘッダ"
}

おまけ

コメント挿入のスニペット( ´∀｀ )

"comment insert": {
	"prefix": "comm",
	"body": "/* $1 */",
	"description": "コメント挿入"
},