是否存在可在PhpStorm结构工具栏创建子章节的DocBlock标签?
在PhpStorm中用DocBlock给结构工具栏添加自定义模块分组
虽然phpdoc官方标准里没有专门用于结构导航分组的标签,但PhpStorm本身支持几个非标准的DocBlock标签来实现这个需求,同时也有插件可以进一步扩展:
使用
@group标签(原生支持)
在类或方法的DocBlock中添加@group 模块名称,PhpStorm会自动在结构工具栏中将同组的方法归为一个可折叠的子章节。示例代码:/** * 用户服务类 * @group 用户管理模块 */ class UserService { /** * 创建用户 * @group 用户管理模块 */ public function createUser(): void {} /** * 删除用户 * @group 用户管理模块 */ public function deleteUser(int $userId): void {} /** * 分配权限 * @group 权限控制模块 */ public function assignPermission(int $userId, string $role): void {} }效果:结构工具栏中会出现「用户管理模块」「权限控制模块」的折叠分组,把对应方法收纳其中,方便快速跳转到指定逻辑模块。
使用
@category标签(原生备选)
和@group功能类似,替换为@category 模块名称即可,PhpStorm同样会识别并生成对应的结构分组,二者的区别仅在于IDE内部的优先级和展示逻辑,实际使用效果接近。插件扩展方案
如果原生标签的分组逻辑满足不了需求,可以尝试PhpStorm插件市场的增强插件,比如Structure Plus:- 支持自定义注释规则生成多级分组
- 可以通过正则匹配自定义的注释格式(比如你和同事约定的特殊标记)来创建更灵活的结构章节
内容的提问来源于stack exchange,提问作者ITalkTooMuchInMeetings
相关产品推荐
相关产品推荐

