讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

Seko
Seko

AI短剧一键生成成片

updream

一键生成高质量推广成片

Laper
Laper

剧本策划到成片协作

Sublime怎么自动补全代码块注释

雨涛吖_9719

雨涛吖_9719

发布时间:2026-11-20 06:24:32

|

514人浏览过

|

来源于php中文网

原创

DocBlockr 是 Sublime 中生成函数级注释块的最佳插件,能自动识别函数签名、参数类型和返回值并生成带 @param 和 @returns 的结构化注释;需正确配置语法、启用 jsdocs_python(Python)、设置 jsdocs_extra_tags 自定义标签,且与 Ctrl+Shift+/ 块注释及 LSP 互补不冲突。

sublime怎么自动补全代码块注释

用 DocBlockr 插件生成函数级注释块

Sublime 原生不支持自动补全代码块注释(比如 /** ... */),必须靠插件。DocBlockr 是目前最稳定、适配语言最多、配置最灵活的方案,它不是简单插入模板,而是能识别函数签名、参数类型、返回值并自动生成占位符。

常见错误现象:/** 回车后没反应,或只生成空的 /** */ —— 大概率是当前文件语法没识别对(右下角显示 Plain Text 或 JavaScript 拼错),或者没装 DocBlockr。

  • 安装路径:按 Ctrl+Shift+P → 输入 Install Package → 搜索 DocBlockr(注意不是 DocBlocker 或 JSDocs)
  • 确认生效:在 .js 或 .py 文件中,光标位于函数定义行上方,输入 /** 后按 Enter,应自动展开带 @param 和 @returns 的结构
  • Python 支持需额外配置:DocBlockr 默认不解析 def 签名,要在 Preferences → Package Settings → DocBlockr → Settings - User 中加 "jsdocs_python": true
  • 如果函数有类型注解(如 def foo(x: str) -> int:),DocBlockr 能提取 str 和 int 填入 @param 和 @returns,但要求语法高亮为 Python,不是 Python Improved 或其他变体

块注释 ≠ 函数注释:别混淆 Ctrl+Shift+/ 和 DocBlockr

Ctrl+Shift+/ 是 Sublime 内置的「块注释」快捷键,作用是用 /* */ 或 """ """ 包裹选中代码,它不生成文档式注释,也不感知函数结构——它只是文本包裹工具。

容易踩的坑:Ctrl+Shift+/ 在 Python 文件里默认不响应(原生模式无 block_comment 配置),强行配了 """ 也只会机械包裹,不会加空行、缩进或 Args: 标题;而 DocBlockr 是语义级的,只在函数/类定义前触发,和选中范围无关。

  • 验证 Ctrl+Shift+/ 是否可用:打开一个 .js 文件,选中几行,按快捷键,看是否出现 /* 和 */;若无反应,说明当前语法未定义 block_comment 字段
  • 想让 Python 也支持 Ctrl+Shift+/ 块注释?得手动编辑 Python 插件的配置,路径是 Packages/Python/Python.sublime-settings,加 "block_comment": ["\"\"\"", "\"\"\""],但注意这和 DocBlockr 完全无关
  • 二者可共存:你仍可用 Ctrl+Shift+/ 临时禁用一段逻辑,再用 DocBlockr 给函数加正式文档

自定义注释模板要改 jsdocs_extra_tags,不是改 snippet

很多人想加 @author 或 @date,就去改 sublime-snippet 文件,结果发现 /** 回车后不生效——因为 DocBlockr 不读 snippet,它读的是自己的 JSON 配置项 jsdocs_extra_tags。

性能影响很小,但配置错字段名(比如写成 extra_tags 漏掉 jsdocs_ 前缀)会导致整个插件静默失效,连基础 @param 都不生成。

  • 正确配置位置:Preferences → Package Settings → DocBlockr → Settings - User
  • 示例(兼容 JS/TS/Python):
    {
      "jsdocs_extra_tags": ["@author ${1:your_name}", "@date {{datetime}}"],
      "jsdocs_function_description": true,
      "jsdocs_notation": "jsdoc"
    }
  • {{datetime}} 是 DocBlockr 内置变量,会转成 2026-11-04T13:57:00+0800;${1:...} 是 Sublime 占位符,Tab 可跳转编辑
  • 删掉不需要的字段(如 @version)比留着更安全,避免生成空行或误导性标签

LSP 补全不负责注释,别指望它替代 DocBlockr

有人装了 LSP + pylsp,发现输 /** 还是没反应,就怀疑 LSP 配置错了——其实 LSP 根本不处理注释生成,它的职责是函数签名提示、跳转定义、悬停文档,和注释块自动补全是两条技术路径。

复杂点在于:如果你同时开了 LSP 和 DocBlockr,且都监听 . 或 /,可能触发冲突(比如输 os. 时弹出 LSP 方法列表,但 /** 回车却卡住)。这不是 bug,是设计使然。

  • DocBlockr 依赖语法作用域(source.python)和光标上下文(必须在 def 或 function 关键字正上方)
  • LSP 依赖语言服务器进程和 textDocument/completion 请求,它不会拦截 /** 这种非标识符输入
  • 两者真正重叠的只有「悬停提示」:DocBlockr 生成的 @param 注释,LSP 能在调用时读出来显示在 tooltip 里;但生成动作本身,LSP 不参与

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

20

2026.11.17

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

40

2026.11.17

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

20

2026.11.17

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

20

2026.11.17

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

40

2026.11.17

SQLAlchemy ORM 模型怎么写
SQLAlchemy ORM 模型怎么写

SQLAlchemy ORM 模型怎么写?本专题整理模型类定义、Mapped 字段映射、主键与约束、表结构创建和常见报错的相关文章,帮助你从基础配置到实际建模逐步掌握 SQLAlchemy。

20

2026.11.17

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

180

2026.11.12

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

140

2026.11.12

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

140

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn