返回

CommentShell，专注注释实现强大的功能！

前端

Webstorm开发利器CommentShell来了！
日常工作中，我们免不了使用注释来编写代码，注释主要用来向我们或者是其他开发人员提供关于代码的信息，说明代码的作用，提醒注意事项，帮助我们更好的理解代码。

但有没有想过注释除了编写代码的辅助作用，还能做什么？那就是让我们能够在注释中运行命令，这样能够节约许多切换窗口、反复切换到文件资源管理器或者终端的繁琐工作，尤其适用于单元测试工作中，运行测试命令，比如下面这种场景：

// TODO(developer): Uncomment these variables before running the sample.
// const projectId = 'my-project';
// const location = 'us-east1';

只要点击运行，就可以在注释中执行命令！这极大地加快了开发速度。

CommentShell的安装和使用方法

在idea的扩展市场中搜索CommentShell，也可以点击链接安装：https://plugins.jetbrains.com/plugin/14835-comment-shell
安装完成后，在File -> Settings -> Tools -> Comment Shell找到Comment Shell选项，找到对应的注释类型，比如在JS脚本中，配置JavaScript as // (Line Comment)的格式，其他语言对应其他的规则，以'//'开头的语句为注释，以'//'开头的语句都可以。

接下来就可以在注释中编写shell命令了，比如说在js文件中编写注释，

// echo hello world!

执行注释后，就可以在控制台看到打印的语句了，是不是非常方便？

CommentShell的用途

除了能直接执行命令，CommentShell还支持：

  • 通过注释，可以进行文件的处理，比如：
// touch ${HOME}/.cshrc

  • 当作为独立的运行环境时，comment shell可以通过管道将命令的输出作为另一个命令的输入，这可以很方便的使用git的diff命令，作为另一个命令的输入。

  • 同时还支持从配置json文件中获取变量，在注释中使用：

{
  "variables": {
    "workspaceRoot": "${PROJECT_DIR}",
    "currentUser": "${USER}"
  }
}

是不是非常方便？

Webstorm插件CommentShell，助你成为优秀的开发人员，让工作变得更轻松，让开发变得更有趣！