vscode实现代码模板功能

一、代码模板

1、在file->preference下打开configure snippets,语言C选择

2、将下述代码替换原代码并保存关闭

3、在文件下,输入“prefix”内容+ tab,自动输出模板:当前实现以下功能

1)输入cfile并点击TAB:文件注释模板,如下:

/**
 * @file    test_for_snippets.c
 * @brief   Brief description
 * @details Detailed description
 * @author  Your Name
 * @date    2025-03-21
 * @version 1.0
 */

2)输入cfun并点击TAB:函数注释模板,如下

 /**
  * @brief   Brief description
  * @details Detailed 
  * @param   param_1
  * @param   param_2
  * @return  return description
  */

3)输入cheader并点击TAB:头文件框架模板,如下

 #ifndef __TEST_FOR_SNIPPETS_H__
 #define __TEST_FOR_SNIPPETS_H__
 

 #endif /* __TEST_FOR_SNIPPETS_H__ */

4、可根据格式自己扩展其他功能

。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。。

“configure snippets”格式代码

{
    "C file Template": {
        "prefix": "cfile",
        "body": [
            "/**",
            " * @file    ${TM_FILENAME}",
            " * @brief   ${1:Brief description}",
			" * @details ${3:Detailed description}",
            " * @author  ${2:Your Name}",
            " * @date    $CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE",
            " * @version 1.0",
            " */"
        ],
        "description": "生成Doxygen格式C文件注释模板"
    },

	"C function Template": {
        "prefix": "cfun",
        "body": [
            "/**",
            " * @brief   ${1:Brief description}",
			" * @details ${2:Detailed }",
            " * @param   ${3:param_1}",
			" * @param   ${4:param_2}",
            " * @return  ${5:return description}",
            " */"
        ],
        "description": "生成Doxygen格式函数注释"
    },

	"C Header Template": {
		"prefix": "cheader",
		"body": [
			"#ifndef __${TM_FILENAME_BASE/(.*)/${1:/upcase}/}_H__",
			"#define __${TM_FILENAME_BASE/(.*)/${1:/upcase}/}_H__",
			"",
			"",
			"#endif /* __${TM_FILENAME_BASE/(.*)/${1:/upcase}/}_H__ */"
		],
	    "description": "Create a header file template"
	}
}

在 Visual Studio Code 中配置和使用 C++ 代码模板,可以通过以下步骤实现高效的开发流程: ### 配置用户代码片段 1. 打开 VSCode,点击菜单栏中的 **文件(File)** -> **首选项(Preferences)** -> **配置用户代码片段(Configure User Snippets)**。 2. 在弹出的选项中选择 **C++** 或创建一个新的全局代码片段文件(如 `cpp.json`)。 3. 编辑 JSON 文件,定义代码模板的名称、前缀、内容和描述。每个代码段由 `prefix`、`body` 和 `description` 组成: - `prefix`:触发代码段的关键字。 - `body`:模板的具体内容,可以使用 `$1`、`$2` 等表示光标跳转顺序,`$0` 表示最终光标位置。 - `description`:描述信息,用于智能提示。 例如,一个完整的 C++ 模板可以如下所示: ```json { "C++": { "prefix": "cpp", "body": [ "#include <iostream>", "#include <vector>", "", "using namespace std;", "", "int main() {", " $0", " system(\"pause\");", " return 0;", "}" ], "description": "生成一个带有标准头文件和主函数的C++模板" } } ``` ### 使用代码模板 1. 在编辑器中打开一个新的 `.cpp` 文件。 2. 输入你定义的前缀(如 `cpp`),VSCode 会自动弹出智能提示。 3. 按下 **Tab** 键,代码模板将自动生成到文件中,并根据 `body` 中的 `$0` 定位光标位置。 ### 自定义其他模板 除了主文件模板外,还可以定义一些常用的代码片段,比如打印语句或文件头注释: ```json { "print-to-console": { "prefix": "sout", "body": ["cout << $0 << endl;"], "description": "快速插入输出语句" }, "Add File Header": { "prefix": "fileheader", "body": [ "/**", " * @file :${TM_FILENAME}", " * @brief :$1", " * @author :李显赫", " * @version :V1.0.0", " * @date :${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}", " */" ], "description": "添加文件头注释" } } ``` ### 注意事项 - 如果模板未生效,请检查是否被其他扩展干扰,或者尝试重启 VSCode。 - 确保所有默认的解释性代码(如空文档生成代码)都被注释掉,以避免冲突[^4]。 - 可以结合其他插件(如 C/C++、Clang-Format)优化代码风格和补全体验[^2]。 ### 代码格式化与提示设置 为了提升开发体验,建议在 `settings.json` 中添加以下配置: ```json { "editor.rulers": [80], "editor.tabSize": 2, "editor.detectIndentation": false, "editor.fontFamily": "monospace", "C_Cpp.clang_format_fallbackStyle": "Google", "C_Cpp.clang_format_style": "Google", "editor.formatOnSave": true, "editor.renderWhitespace": "all", "editor.quickSuggestionsDelay": 1, "editor.suggest.snippetsPreventQuickSuggestions": false, "editor.hover.delay": 300, "C_Cpp.intelliSenseEngine": "Tag Parser" } ``` 这些设置将启用保存时自动格式化、代码提示延迟缩短等功能,同时确保 STL 库相关的代码提示正常工作[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值