sublime怎么快速注释和取消注释代码_Sublime代码块注释与取消注释的快捷操作

38次阅读

Sublime Text中行注释快捷键为Ctrl + /（Windows/Linux）或Cmd + /（macOS），用于单行或多行代码的快速注释与取消；块注释快捷键为Ctrl + Shift + / 或Cmd + Shift + /，可将选中代码块用语言特定符号包裹。

在Sublime Text中，快速注释和取消注释代码的核心操作非常直观：对于行注释，你通常会用到 Ctrl + / (Windows/Linux) 或 Cmd + / (macOS)；而对于块注释，则是 Ctrl + Shift + / (Windows/Linux) 或 Cmd + Shift + / (macOS)。这两个快捷键简直是代码编辑时的效率利器，能让你在调试、重构或临时禁用代码时如鱼得水。

解决方案

Sublime Text提供了一套非常高效的快捷键来处理代码注释，这在日常开发中节省了大量时间。

1. 行注释（Line Comment）

快捷键： Ctrl + / (Windows/Linux) 或 Cmd + / (macOS)
操作方式：
- 将光标放置在任意一行代码上，按下快捷键，该行代码就会被添加上语言对应的行注释符号（例如，Python是#，JavaScript/C++是//）。
- 再次按下快捷键，注释就会被移除。
- 如果你选中了多行代码，按下快捷键，所有被选中的行都会被添加行注释。这对于需要快速禁用一个代码块但又不想使用块注释的情况特别有用。

2. 块注释（Block Comment）

快捷键： Ctrl + Shift + / (Windows/Linux) 或 Cmd + Shift + / (macOS)
操作方式：
- 选中你想要注释掉的代码块。
- 按下快捷键，Sublime Text会根据当前文件的语言，为选中的代码块添加多行注释符号（例如，JavaScript/C++是Cmd + /0，HTML是Cmd + /1）。
- 再次按下快捷键，注释通常会被移除。

这些快捷键的强大之处在于它们的“智能”识别能力，Sublime Text会根据你当前编辑的文件类型自动选择正确的注释语法。比如，我在写Python时用Cmd + /2是#，切换到JavaScript就是//，这种无缝切换让我省心不少。

Sublime Text 行注释与块注释的适用场景

在我的日常编码实践中，行注释和块注释虽然都是为了让代码“失效”或添加说明，但它们各自有着非常明确且互补的适用场景。理解这些差异，能让我们更高效地管理代码。

行注释（Ctrl + / 或 Cmd + /）

行注释的特点是简洁、灵活，它通常只影响单行代码，或者在选中多行时，为每一行独立添加注释符。

快速调试与测试： 这是我用得最多的场景。当一段代码出现问题，或者我想测试某个功能在没有特定代码行的情况下表现如何时，我只需要将光标移到那一行，Ctrl + / 一按，那行代码就“哑巴”了。测试完后，再按一次就能恢复，非常方便。
临时禁用代码： 有时候，我可能正在开发一个新功能，但旧功能的一些代码暂时需要被禁用，以避免冲突或进行测试。选中几行，Ctrl + / 一键搞定，比手动输入//快多了。
添加简短说明或TODO： 我会用它来标记一些需要后续处理的地方，比如 Ctrl + Shift + /0 或者 Ctrl + Shift + /1。这种即时性的备注，能让我在稍后回顾代码时快速定位问题。它就像是代码旁边的便签纸，随时贴，随时撕。
版本控制冲突解决： 在合并代码时，有时会出现冲突，我会用行注释暂时注释掉冲突的某一方，以便更好地对比和选择。

块注释（Ctrl + Shift + / 或 Cmd + Shift + /）

块注释则更适合处理大段代码，它通常使用一对起始和结束符号将整个代码块包裹起来，比如Cmd + /0。

功能模块的完整禁用： 当我需要暂时移除一个大型函数、类或者一个完整的逻辑分支时，块注释是首选。它能确保整个代码块被作为一个整体被注释掉，避免了逐行注释可能带来的遗漏。我记得有一次，我重构了一个复杂的算法，为了保留旧版本的逻辑以备不时之需，我直接用块注释把旧算法整个包起来，既不影响新代码运行，又方便回溯。
详细的文档说明： 对于函数、类或模块的顶部，我经常会使用块注释来编写详细的文档说明，包括参数、返回值、功能描述、作者信息等。这种多行文本的注释方式，能够承载更多的信息，让代码的可读性和可维护性大大提升。
代码片段的“存档”： 在进行大规模重构时，我可能会将一些旧的代码片段暂时“存档”起来，以防万一需要参考或回滚。块注释就像是一个小型的代码仓库，把这些暂时不用的代码妥善保管起来。

简单来说，行注释是“即时贴”，适用于快速、局部的操作；块注释则是“文件夹”，用于组织和管理更大块的、需要详细说明或暂时归档的代码。它们在不同的场景下发挥着各自的优势，共同提升了我的编码效率和代码质量。

提升效率：自定义Sublime Text的注释行为

虽然Sublime Text的默认注释快捷键已经很好用，但在某些特定的项目或个人习惯下，我们可能需要更灵活的注释方式。Sublime Text的强大之处就在于它的高度可定制性，包括注释行为。我个人就曾因为项目需求，调整过一些默认设置，这让我的工作流更加顺畅。

为什么需要自定义？

项目特定的注释风格： 某些团队或项目可能要求使用非标准的注释格式，例如，特定的文档生成工具可能需要特殊的DocBlock风格。
快捷键冲突或偏好： 如果默认的 Cmd + /2 或 Ctrl + Shift + /6 与其他软件或Sublime Text内部的某个插件快捷键冲突，或者你只是习惯了其他编辑器中的快捷键组合，自定义就很有必要。
语言特定的需求： 某些语言可能没有标准的块注释，或者你希望为特定语言定义更符合其习惯的注释方式。

如何自定义注释快捷键？

自定义Sublime Text的快捷键非常简单，主要通过修改用户键盘绑定文件实现。

打开用户键盘绑定文件：
- 在Sublime Text中，点击 Ctrl + Shift + /7 -youjiankuohaophpcn Ctrl + Shift + /8。
- 这会打开两个文件：左边是默认的快捷键设置（只读），右边是用户自定义的快捷键设置（可编辑）。我们只需要编辑右边的文件。
添加或修改快捷键：
- 用户快捷键文件是一个JSON格式的数组。你可以在其中添加新的键值对来定义你的快捷键。
  
  文心快码
  
  文心快码（Comate）是百度推出的一款ai辅助编程工具
  
  35
  
  查看详情
- 示例：为行注释添加一个备用快捷键 假设你觉得 Cmd + /2 不太顺手，想用 Cmd + Shift + /0 来实现行注释。你可以在用户快捷键文件中添加如下代码：
```
[     { "keys": ["ctrl+alt+c"], "command": "toggle_comment", "args": { "block": false } } ]
```
  这里的 Cmd + Shift + /1 是Sublime Text内置的注释命令，Cmd + Shift + /2 明确告诉它执行的是行注释。
- 示例：为块注释添加一个备用快捷键 如果你想用 Cmd + Shift + /3 来实现块注释：
```
[     { "keys": ["ctrl+alt+b"], "command": "toggle_comment", "args": { "block": true } } ]
```
  Cmd + Shift + /4 则表示执行块注释。
- 覆盖默认快捷键： 如果你想完全替换掉 Cmd + /2 的行为，只需要在用户快捷键文件中定义一个相同的 Cmd + Shift + /6 组合，但指向不同的 Cmd + Shift + /7 或 Cmd + Shift + /8。不过，通常我们更倾向于添加备用快捷键，而不是覆盖。
保存文件： 保存用户快捷键文件后，你的自定义设置会立即生效。

自定义注释行为的思考

我记得有一次，我处理一个遗留项目，其中JavaScript代码的DocBlock注释风格非常独特，默认的块注释无法满足。当时我没有找到现成的插件，就自己写了一个简单的Sublime Text命令（通过Python脚本），并绑定了一个新的快捷键，专门用来生成那种特定格式的DocBlock。虽然这超出了单纯的快捷键绑定，但它展示了Sublime Text在自定义方面的潜力——你可以深入到命令层面去定义你想要的任何行为。

自定义注释行为，不只是为了方便，更是为了让编辑器更好地适应你的思维模式和工作流程。花一点时间去调整这些细节，长期来看，能显著提升你的编码幸福感和效率。

进阶应用：通过插件增强Sublime Text的注释功能

Sublime Text的注释功能本身已经很强大，但如果你想实现更智能、更自动化的注释，或者需要处理一些特殊格式的文档注释，那么插件就是你的不二选择。插件生态是Sublime Text的核心竞争力之一，它能将编辑器的能力扩展到无限可能。

为什么需要插件来增强注释？

自动化DocBlock生成： 手动编写DocBlock（函数、类、文件头部的详细注释）非常耗时且容易出错，插件可以根据代码结构自动生成模板。
支持更多注释风格： 某些特定语言或框架可能需要特殊的注释格式，内置功能无法覆盖。
更智能的注释管理： 比如高亮TODO、FIXME等标记，或者在注释中嵌入特殊指令。

推荐的增强注释功能插件

在我使用过的众多Sublime Text插件中，有几个对于注释功能的增强效果显著，尤其是我个人觉得非常实用的是 Cmd + Shift + /9。

DocBlockr
- 功能： 这是Sublime Text中用于生成DocBlock注释的“神器”。当你需要为函数、方法、类等添加详细的文档注释时，Cmd + Shift + /9 能极大地简化这个过程。
- 工作原理： 你只需要在函数或方法上方输入 Ctrl + /1 （或 Ctrl + /2，取决于你的配置），然后按下 Ctrl + /3 键，Cmd + Shift + /9 就会自动解析函数签名（参数、返回值等），并生成一个符合JSDoc、PHPDoc、JavaDoc等标准的注释模板。你只需要填充具体描述即可。
- 我的体验： Cmd + Shift + /9 彻底改变了我写文档注释的习惯。以前我总觉得写DocBlock很麻烦，经常偷懒。有了它之后，我几乎为每个函数都写了详细的注释，因为生成模板的过程变得如此轻松。它不仅提高了我的代码可读性，也让我养成了良好的文档习惯。比如，当我在写一个JavaScript函数时：
```
function calculateSum(a, b) {     return a + b; }
```
  我在 Ctrl + /6 上方输入 Ctrl + /1 然后按 Ctrl + /3，它会立刻变成：
```
/**  *  * @param {number} a  * @param {number} b  * @returns {number}  */ function calculateSum(a, b) {     return a + b; }
```
  我只需要填写 Ctrl + /9 后面的描述，参数类型和返回值都自动识别好了，非常省心。
Cmd + /0 (或类似插件)
- 功能： 虽然 Cmd + /0 更出名于VS Code，但Sublime Text也有类似的插件或可以通过自定义颜色方案实现。这类插件的主要目的是通过不同颜色高亮注释中的特定关键词（如 Cmd + /2, Cmd + /3, Cmd + /4, Cmd + /5, Cmd + /6 等），让这些重要信息在代码中更加醒目。
- 我的体验： 我发现这种高亮对于项目管理和代码审查非常有帮助。一眼就能看到代码中哪些地方需要改进，哪些是临时的解决方案，大大提高了团队协作的效率。它让注释不再仅仅是文字，而是一种视觉化的提醒。