IDEA中Commit Comment插件的安装及使用

      这个插件的好处就在于,可以便捷的生成规范化的代码提交注释,并且对提交的注释进行分类,让你一眼就知道,这个提交的内容涉及哪方面。这个是中文版的,英文版的叫Git Commit Template。

 

安装方法:

1、File→Settings→Plugins,输入commit comment,本地没搜到,就可以点击Search in repositories(或直接点击Browse repositories进入搜索),搜到Commit Comment后选择Install进行安装即可,安装后需重启IDEA。

 

使用方法:

1、安装完后,在提交代码的时候,Commit Changes面板的Commit Message上方,有一个纸飞机按钮,点击打开Commit Comment面板,在这里填提交注释就可以自动生成格式化的注释,如红线处。

 

可选的提交类型如下,还是比较全面的:

[新增功能]-新的功能、新的需求

[Bug修复]-修复代码Bug(测试、验收等阶段的Bug)

[代码完善]-开发自测过程中遗漏的代码逻辑

[文档修改]-仅文档更改(代码注释、README等)

[样式修改]-不影响代码功能的修改 (CSS样式、代码格式化等)

[代码重构]-既不修复错误也不添加功能的代码更改

[性能优化]-提高性能的代码更改

[测试代码]-添加缺失的测试或更正现有的测试

[编译代码]-影响构建系统或外部依赖项的更改(示例:yarn、npm)

[持续集成]-对CI配置文件和脚本的更改(示例:Jenkinsfile、gitlab-ci、Dockerfile)

[代码回退]-恢复之前的提交,代码回滚

[其他更改]-不修改代码或测试文件的其他更改

 

posted @ 2022-10-09 18:18  PC君  阅读(1280)  评论(0编辑  收藏  举报