vscode 用户自定义代码片段：如何获取该文件名

自定义代码片段在Visual Studio Code (VS Code) 中是一项强大的功能，它可以显著提高编码效率。要获取当前文件的文件名，你可以在用户代码片段中使用特定的变量。这些变量由VS Code提供，能够动态插入文件属性如文件名、文件路径等。要获得当前文件的文件名，你可以使用$TM_FILENAME这个预定义的变量。例如，当你需要在代码中添加一个注释，标注当前的文件名时，就可以利用这个变量来自动插入文件名。

扩展展示：

$TM_FILENAME是一个系统变量，不需要用户进行任何额外定义，VS Code会在执行代码片段时自动替换这个变量为当前文件的文件名。例如，如果你正在编辑的文件名是example.js，使用$TM_FILENAME在插入的代码片段中将会自动被替换成example.js。

一、创建用户自定义代码片段

要创建用户自定义代码片段，你需要先访问VS Code的命令面板并选择或创建一个代码片段文件：

1. 打开命令面板(Ctrl+Shift+P on Windows, Command+Shift+P on macOS)。
2. 输入"configure user snippets"并选择它。
3. 选择相应的语言，例如JavaScript，则选择"JavaScript"。

你将被引导创建或修改一个.json文件，这里你可以添加或编辑自定义的代码片段。

二、添加代码片段

在打开的代码片段文件中，你可以定义一个新的代码片段，使用$TM_FILENAME变量来获取文件名：

{

    "Print to console": {
        "prefix": "logfilename",
        "body": [
            "// Current File: $TM_FILENAME",
            "console.log('Current File: $TM_FILENAME');"
        ],
        "description": "Log the current file name"
    }
}

三、使用自定义代码片段

创建完代码片段之后，要使用它，只需在编辑器中输入其前缀（在本例中为"logfilename"），然后从自动补全建议中选中它。你将看到前缀补全成了设置好的片段模板。

四、其他可用变量

除了$TM_FILENAME，VS Code还提供了其他系统变量供代码片段使用：

• $TM_DIRECTORY：当前文件的目录。
• $TM_FILEPATH：当前文件的完整路径。
• $CURRENT_YEAR、$CURRENT_MONTH、$CURRENT_DATE：当前的年、月、日。

这些变量可以与$TM_FILENAME一起使用，提供更多关于文件的动态信息。

五、实际应用示例

使用场景：

假设你经常需要在多个文件中插入一个标准的版权声明，这些文件可能是.js文件或.css文件，你希望版权声明中包含当前文件的名称。

可以定义以下代码片段：

{

    "Copyright notice": {
        "prefix": "copyright",
        "body": [
            "/*",
            " * Copyright (c) ${CURRENT_YEAR} Your Company",
            " * File: $TM_FILENAME",
            " *",
            " * All rights reserved.",
            " */"
        ],
        "description": "Add a copyright notice with the file name"
    }
}

当你在任何.js或.css文件中键入copyright并选择这个代码片段时，它将自动插入版权声明，并把$TM_FILENAME替换成当前编辑的文件名。

综上，通过运用$TM_FILENAME这一系统变量，你可以在VS Code中创建能够自动获取并使用当前文件名的高效代码片段，极大地提升编程工作效率。

相关问答FAQs：

1. 如何在VSCode中获取当前文件的文件名？

在VSCode中，要获取当前文件的文件名，你可以使用以下方法：

• 使用VSCode内置的快捷键：按下Ctrl + Shift + P，然后输入Copy Absolute Path，按下回车。这将把当前文件的完整路径复制到剪贴板中。你可以从中提取文件名。
• 使用VSCode的内置变量：你可以在自定义代码片段中使用${TM_FILENAME}变量来获取当前文件的文件名。在代码片段中使用${TM_FILENAME}将自动插入当前文件的文件名。

2. 如何在VSCode的自定义代码片段中获取当前文件的文件名？

在VSCode中，你可以在自定义代码片段中通过${TM_FILENAME_BASE}变量来获取当前文件的文件名（不包括扩展名）。以下是获取当前文件名的示例代码片段：

"Print Filename": {
    "prefix": "pf",
    "body": [
        "console.log('Current filename: ${TM_FILENAME_BASE}');"
    ],
    "description": "Prints the current filename"
}

在代码片段中，${TM_FILENAME_BASE}将被替换为当前文件的文件名。

3. 如何在VSCode的自定义代码片段中获取当前文件的完整路径？

在VSCode中，如果你想要获取当前文件的完整路径，你可以使用${file}变量。以下是获取当前文件完整路径的示例代码片段：

"Print File Path": {
    "prefix": "pfp",
    "body": [
        "console.log('Current file path: ${file}');"
    ],
    "description": "Prints the current file path"
}

在代码片段中，${file}将被替换为当前文件的完整路径。你可以根据需要进行进一步的处理和提取。