2022-11-24-code-commit

cunyu1943 · cunyu1943 · commit d84e277ebce1 · 2022-11-25T20:53:57.000+08:00
diff --git a/README.md b/README.md
@@ -17,6 +17,8 @@
 <center><img width="400px" src="./src/.vuepress/public/logo.png"></center>
 
 ## 🔖 目录
+- [📖 JavaPark | Java 自学指南](#-javapark--java-自学指南)
+  - [🔖 目录](#-目录)
   - [简介](#简介)
   - [Java](#java)
     - [Java 菜鸟入门](#java-菜鸟入门)
@@ -30,7 +32,7 @@
     - [Spring Boot 基础教程](#spring-boot-基础教程)
     - [HTML 教程](#html-教程)
     - [JS 教程](#js-教程)
-    - [Vue3 笔记](#vue3-笔记)
+    - [Vue3-笔记](#vue3-笔记)
     - [Nginx 教程](#nginx-教程)
   - [面试宝典](#面试宝典)
   - [计算机基础](#计算机基础)
@@ -44,15 +46,14 @@
     - [博客搭建](#博客搭建)
     - [效率提升](#效率提升)
     - [资源推荐](#资源推荐)
-    - [Linux 教程](#linux-教程)
-    - [macOS 教程](#macos-教程)
     - [Windows 教程](#windows-教程)
+    - [macOS 教程](#macos-教程)
+    - [Linux 教程](#linux-教程)
   - [考试打怪](#考试打怪)
     - [软件设计师](#软件设计师)
   - [与我联系](#与我联系)
     - [加群交流](#加群交流)
     - [公众号『村雨遥』](#公众号村雨遥)
-
   - [转载分享](#转载分享)
   - [Star 趋势图](#star-趋势图)
 
@@ -211,7 +212,8 @@
 5.  [IDEA 教程：不得不知的实用小技巧](src/md/dev-tools/idea/2022-02-05-idea-tips.md)
 6.  [IDEA 教程：创建 Java 入门应用](src/md/dev-tools/idea/2022-02-06-java-quick-start-with-idea.md)
 7.  [IDEA 教程：连接 MySQL 失败解决方案](src/md/dev-tools/idea/2022-02-07-connect-mysql-fail.md)
-8.  [IDEA 教程：Tomcat 控制台乱码解决方法](src/md/dev-tools/idea/2022-02-08-tomcat-console-error-code.md)
+8.  [IDEA 教程：IDEA 代码提交前流程及提交日志模板化](src/md/dev-tools/idea/2022-11-24-code-commit.md)
+9.  [IDEA 教程：Tomcat 控制台乱码解决方法](src/md/dev-tools/idea/2022-02-08-tomcat-console-error-code.md)
 
 ## 效率工具
 
diff --git a/src/md/dev-tools/idea/2022-11-24-code-commit.md b/src/md/dev-tools/idea/2022-11-24-code-commit.md
@@ -0,0 +1,290 @@
+---
+title: IDEA 代码提交前流程及提交日志模板化
+date: 2022-11-24
+isOriginal: true
+order: 31
+category:
+    - IDEA 教程
+---
+
+作者：村雨遥
+
+博客：[JavaPark](https://cunyu1943.github.io/JavaPark)
+
+原文：https://mp.weixin.qq.com/s/Mhc7tygE6Fl5_3h8mz7A9g
+
+>   吾生也有涯，而知也无涯。
+---
+
+## 前言
+
+在开发大型项目时，通常都是由团队来进行开发。此时，每个人有每个人的代码编写风格和提交习惯，如果放任自由发挥，那么代码质量和代码提交日志就难免风格各异，导致项目代码质量难以保持统一。针对这一问题，往往公司在以项目组进行开发时，在进入正式编码前，都会制定一个标准的流程，用来规范代码提交前的流程，同时对提交日志进行规范化。从而最大程度上保持项目的代码风格统一，提高代码可读性。
+
+以下就给大家介绍一下最常见的代码提交前的规范化流程，以及如何模板化我们的代码提交日志。
+
+## 代码提交前检查流程
+
+### 推荐插件
+
+#### p3c
+
+- **下载地址**
+
+>   https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions
+
+-   **安装及使用**
+
+>   https://github.com/alibaba/p3c/wiki/IDEA%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3
+
+####  SonarLint
+
+- **下载地址**
+
+>   https://plugins.jetbrains.com/plugin/7973-sonarlint/versions
+
+-   **安装及使用**
+
+>   https://www.cnblogs.com/cocoxu1992/p/11336723.html
+
+
+
+### 提交前的配置项
+
+![提交前的配置](https://img-blog.csdnimg.cn/fcb9af8780484cab9a63310e7d00c06d.png)
+
+#### Alibaba Code Guidelines
+
+安装 `p3c` 插件后，才会有该选项。在提交代码改动之前，如果勾选此选项，则会去扫描代码中不符合 `p3c` 规则中的代码，然后弹窗提示存在可疑代码，此时可以到控制台查看存疑的代码。然后只需要根据控制台中提示的去修改代码即可。
+
+- 代码存疑弹窗
+![](https://img-blog.csdnimg.cn/125e2dac822d41639a28a5776dd7ba12.png)
+- 控制台中存疑的代码提示
+![](https://img-blog.csdnimg.cn/6f7bec02753d4cbba1b651411ea8c79a.png)
+
+#### Reformat code
+
+提交前格式化代码，假设我们在代码中写了如下代码：
+
+```java
+int a=3;
+```
+
+如果我们在提交前勾选了此选项，提交时 `IDEA` 就会自动对此行代码进行格式化，变成以下的格式，从而大大提高代码可读性。
+
+```java
+int a = 3;
+```
+
+#### Rearrange code
+
+重新编排代码，IntelliJ IDEA 支持各种复杂的编排设置选项，当我们在 IDEA 中设置好了编码功能之后，这里就可以尝试勾选这个进行自动编排。不过一般没有去做特定的编码功能设置，因此建议不勾选。
+
+#### Optimize imports
+
+优化导包（删除无用的导包）。假如在写代码时一开始引入了 `Scanner` 包，但后续又没有用到，此时勾选此选项 `IDEA` 就会自动将引入的 `Scanner` 包删除。
+
+- 勾选前
+
+```java
+package com.demo;
+
+import java.util.Scanner;
+
+public class Main {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+    }
+}
+```
+
+- 勾选后
+
+```java
+package com.demo;
+
+public class Main {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+    }
+}
+```
+
+#### Analyze code
+
+勾选该选项后，`IDEA` 会用默认的配置文件去扫描我们所写代码的质量。如果扫描发现问题，则会弹出以下类似的弹窗，此时只要点击 `Review` 就可以对代码中存在问题的地方进行 `Review`，根据所给提示对代码进行修改。
+![](https://img-blog.csdnimg.cn/8a087da5e21e41d695a5e0d587ffda72.png)
+
+![](https://img-blog.csdnimg.cn/ba6e3073308b4c5782cb6b6a67299ee4.png)
+
+#### Check TODO
+
+检查代码中存在 `@todo` 注解的地方并给出提示。一般在代码中添加 `@todo` 表示此时代码中还有未完成的功能，此时可以提醒你去补全还未完成的功能代码。
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+        //@todo
+    }
+}
+```
+
+如果我们新增的代码如上，此时如果在提交点前勾选 `Check TODO` 选项，就会弹窗提示。
+
+![](https://img-blog.csdnimg.cn/c4753c81e46245b0906ecbdbf110dac9.png)
+
+此时点击 `Review` 就可以去查看对应分析结果，然后去找到对应 `todo` 所在的代码对它进行补充。
+![](https://img-blog.csdnimg.cn/9d9981a80f674fa78093c04f6592c797.png)
+
+#### Cleanup
+
+清除下版本控制系统，去掉一些版本控制系统的错误信息，主要针对 SVN，Git 不适用，一般建议不勾选。
+
+#### Update copyright
+
+如果代码需要版权标识时，需要提前在 `IDEA` 中配置相关版权信息。配置的流程 `settings->Editor->copyright->copyright profiles`，然后添加类似于以下的版权信息：
+
+```java
+Copyright(c)2002-2022, xxx 有限公司
+项目名称:$project.name
+文件名称:$file.fileName
+Date:$today
+Author:xxx
+```
+
+配置完成后，当提交你的代码更改时，勾选该选项可以检查更新版权，这样提交后更改的文件将有它们的版权更新。
+
+#### Perform SonarLint analysis
+
+安装 `SonarLint` 插件后才会有的选项。勾选该选项后，`SonarLint` 会对代码进行检查，发现代码中的一些 bug、漏洞、异味。然后根据控制台中的提示信息对代码进行修改后再次提交，能够一定程度上提高代码质量。
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        System.out.println("Hello World!");
+        System.out.println("demo");
+        int a;
+        boolean flag = false;
+        //@todo
+    }
+}
+
+```
+![](https://img-blog.csdnimg.cn/cd721721a8ae49f29a62f187d61b7cac.png)
+![](https://img-blog.csdnimg.cn/78ad273a718b4258b02b0e280c514ba5.png)
+
+## 提交日志模板化（Git Commit Template）
+
+### 概述
+
+通过使用该插件，能够规范在使用 `IDEA` 提交代码时的注释说明。通过模板化后的日志，便于快速查找，回溯之前的工作。
+
+### 下载安装
+
+1.   **下载地址**
+
+>   https://plugins.jetbrains.com/plugin/9861-git-commit-template/versions
+
+2.   **安装**
+
+>   https://blog.csdn.net/m0_46636892/article/details/122116712
+
+### 使用教程
+
+#### 提交信息的模板
+
+```
+<type 类型>(<scope 可选作用域>): <subject 描述>
+// 空行
+<body 可选的正文>
+// 空行
+<footer 可选的脚注>
+```
+
+主要分为三部分：
+
+-   Head（`<type 类型>(<scope 可选作用域>): <subject 描述>`）
+-   Body（`<body 可选的正文>`）
+-   Footer（`<footer 可选的脚注>`）
+
+#### Head 参数说明
+
+1.   **type（必填）**
+
+| 类型       | 英文                                                                                                    | 中文说明                                       |
+| ---------- | :------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
+| `feat`     | `A new feature`                                                                                         | 新功能                                         |
+| `fix`      | `A bug fix`                                                                                             | `bug` 修复                                     |
+| `docs`     | `Documention only`                                                                                      | 文档注释                                       |
+| `style`    | `Changes that do not affect the meaning of the code(white-space、formatting、missing semi-colons、etc)` | 不影响代码运行的变动（格式化、去空格等）       |
+| `refactor` | `A code change that neither fixes a bug nor adds a feature`                                             | 重构、优化（既不增加新功能，也不是修复 `bug`） |
+| `perf`     | `A code change that improves performance`                                                               | 性能优化                                       |
+| `test`     | `Adding missing tests or correcting existing tests`                                                     | 增加测试                                       |
+| `build`    | `Changes that affect the build system or external dependencies`                                         | 影响生成构建或外部依赖项的更改                 |
+| `ci`       | `Changes to our CI configuration files and scripts`                                                     | 对配置项配置文件和脚本的更改                   |
+| `chore`    | `Other changes that don't modify src or test files`                                                     | 其他不影响源码和测试的改动                     |
+| `revert`   | `Reverts a previous commit`                                                                             | 回退版本                                       |
+
+2.   **scope（可选）**
+
+用户说明此次提交所影响的范围，常见的有数据层、控制层、视图层等，这个需要根据自己的项目来具体定义。
+
+3.   **subject（必填）**
+
+此次提交的概括，一般建议不超过 50 字，结尾不加任何标点符号。
+
+#### Body 参数说明
+
+对此次提交的详细描述，可以分为多行，每行建议控制在 72 个字以内，以条目的形式给出，范例如下：
+
+```
+- 修复 bug1
+- 修复 bug2
+```
+
+#### Footer 参数说明
+
+主要用于两种情况：
+
+1.   不兼容的变动，对应具体使用部分图中的 `Breaking changes`.
+2.   关闭 `Issue`，对应具体使用部分图中的 `Closed issues`.
+
+#### 具体使用
+
+1.   安装完成后，在代码提交界面会有以下图标，点击进行参数配置。
+
+![](https://img-blog.csdnimg.cn/05b8d9da6c2543f7b5715b5b8b2c43c7.png)
+
+
+
+
+
+2.   根据自己的需求进行相关配置。
+
+![](https://img-blog.csdnimg.cn/3f00fe384f24410881842d8e05579ca9.png)
+
+![](https://img-blog.csdnimg.cn/5608cf18f6434a369fcde51bb1f44235.png)
+
+
+
+
+3.   完成配置之后，点击右下角的 `ok`，就会自动根据模板生成提交的具体信息，最后进行提交即可，一个自动生成的具体示例如下：
+
+
+```java
+fix(改动生效的范围): 代码改动的简述
+
+代码改动的具体描述1
+
+BREAKING CHANGE: 不兼容的变更
+
+Closes 关闭的issue
+```
+
+
+![](https://img-blog.csdnimg.cn/2bc745e949704c7483e8b3d0079fae99.png)
+## 总结
+
+可能屏幕前的你所在的项目组并没有这么多的流程和提交规范，但养成良好的编码习惯总归是好的。代码不仅仅是写给自己看的，一个高手不仅仅是能够实现复杂的功能，能把代码编写得能让人看着简洁清爽也是一种艺术。
+
+好了，今天的文章到此就结束了，感谢大家赏脸阅读。对于文中如果有描述不清的地方，或者有什么建议我改进的建议，欢迎与我讨论交流。
diff --git a/src/md/dev-tools/idea/README.md b/src/md/dev-tools/idea/README.md
@@ -23,4 +23,5 @@ category:
 5.  [IDEA 教程：不得不知的实用小技巧](2022-02-05-idea-tips.md)
 6.  [IDEA 教程：创建 Java 入门应用](2022-02-06-java-quick-start-with-idea.md)
 7.  [IDEA 教程：连接 MySQL 失败解决方案](2022-02-07-connect-mysql-fail.md)
-8.  [IDEA 教程：Tomcat 控制台乱码解决方法](2022-02-08-tomcat-console-error-code.md)
+8.  [IDEA 教程：IDEA 代码提交前流程及提交日志模板化](2022-11-24-code-commit.md)
+9.  [IDEA 教程：Tomcat 控制台乱码解决方法](2022-02-08-tomcat-console-error-code.md)
diff --git a/src/md/java/js/Untitled.md b/src/md/java/js/Untitled.md
@@ -1,9 +1,8 @@
 ---
 title: JS 教程「11」：DOM 节点
-icon: javascript
 isOriginal: true
 date: 2022-04-24 16:15:00
-tag: JavaScript
+order: 1
 index: false
 category: JavaScript 教程
 ---
