格式化代码

2023-09-02 00:10:35 +08:00 · 2023-09-02 00:10:35 +08:00 · 730d2492d9
commit 730d2492d9
parent 03570f5cd1
7 changed files with 63 additions and 27 deletions
--- a/.gitee/ISSUE_TEMPLATE/bug.yml
+++ b/.gitee/ISSUE_TEMPLATE/bug.yml
@ -1,7 +1,7 @@
 name: Bug 反馈
 description: 当你在代码中发现了一个 Bug，导致应用崩溃或抛出异常，或者有一个组件存在问题，或者某些地方看起来不对劲。
 title: "[Bug]: "
-labels: ["bug"]
+labels: [ "bug" ]
 body:
  - type: markdown
    attributes:
--- a/.gitee/ISSUE_TEMPLATE/feature.yml
+++ b/.gitee/ISSUE_TEMPLATE/feature.yml
@ -1,7 +1,7 @@
 name: 功能建议
 description: 对本项目提出一个功能建议
 title: "[功能建议]: "
-labels: ["feature"]
+labels: [ "feature" ]
 body:
  - type: markdown
    attributes:
--- a/.gitee/ISSUE_TEMPLATE/refactor.yml
+++ b/.gitee/ISSUE_TEMPLATE/refactor.yml
@ -1,7 +1,7 @@
 name: 重构
 description: 对本项目提出一个功能建议
 title: "[重构]: "
-labels: ["refactor"]
+labels: [ "refactor" ]
 body:
  - type: textarea
    id: related-problem
--- a/README.md
+++ b/README.md
@ -4,8 +4,9 @@
 ![](https://img.shields.io/badge/Ubuntu-Passing-49%2C198%2C84.svg?style=falt&logo=Ubuntu)
 ![](https://img.shields.io/badge/MacOS-Passing-49%2C198%2C84.svg?style=falt&logo=Apple)

+JNotepad(Java Notepad)是一款简约而强大的跨平台文本编辑器，旨在提供用户友好的界面和丰富的功能。无论你是在Linux、Windows还是macOS系统上使用，JNotepad都能满足你对文本编辑和查看的需求。
+JNotepad使用Java语言编写，并基于JavaFX框架开发，具有良好的可扩展性和稳定性。

-JNotepad(Java Notepad)是一款简约而强大的跨平台文本编辑器，旨在提供用户友好的界面和丰富的功能。无论你是在Linux、Windows还是macOS系统上使用，JNotepad都能满足你对文本编辑和查看的需求。 JNotepad使用Java语言编写，并基于JavaFX框架开发，具有良好的可扩展性和稳定性。
 ## 功能介绍

 - 文本编辑和查看：JNotepad提供了完善的文本编辑和查看功能，使你能够轻松创建、编辑和浏览各种类型的文本文件。
@ -16,31 +17,32 @@ JNotepad(Java Notepad)是一款简约而强大的跨平台文本编辑器，旨

 - 基于Java：JNotepad使用Java语言编写，并基于JavaFX框架开发，具有良好的可扩展性和稳定性。

-
 ## 安装教程

-1.  Windows 平台，可以直接使用我编译好的可执行程序或自己编译
+1. Windows 平台，可以直接使用我编译好的可执行程序或自己编译

 [gitee-download]: https://gitee.com/jcnc-org/JNotepad/releases
+
 [java-download]: https://www.oracle.com/cn/java/technologies/downloads/
+
 [qq-url]: http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=zOfwWb1lcle68cbEdJCjSIp3Itx0nEC0&authKey=bOsZFT9OVYZpZQbS6IYO4onBQoeBorF5nanMEi1G%2FgPbzmUkOweXBo9qB0G34R5K&noverify=0&group_code=386279455

-
-
 - [下载][gitee-download]

 2. Linux/MacOS 平台，查看入门指南

-
 ## 入门指南

 要使用 JNotepad，请按照以下步骤进行:

 1. 下载并安装 Java（如果尚未安装）。
+
 - [下载][gitee-download]

 2. 克隆或下载 JNotepad 项目。
+
 <pre><code>git clone https://gitee.com/jcnc-org/JNotepad.git</code></pre>
+
 3. 在您偏好的 Java IDE 中打开项目。

 ## 使用方法
@ -48,10 +50,12 @@ JNotepad(Java Notepad)是一款简约而强大的跨平台文本编辑器，旨
 1. 运行 `JNotepad` 类以启动应用程序。
 2. 主窗口将显示菜单栏、标签区域和状态栏。
 3. 使用菜单栏执行各种操作：
-  - `文件 > 新建`：创建一个带有空白文本区域的新标签。
-  - `文件 > 打开`：打开现有文本文件进行编辑。
-  - `文件 > 保存`：将当前活动标签的内容保存到关联文件中。
-  - `文件 > 另存为`：将当前活动标签的内容保存为新文件。
+
+- `文件 > 新建`：创建一个带有空白文本区域的新标签。
+- `文件 > 打开`：打开现有文本文件进行编辑。
+- `文件 > 保存`：将当前活动标签的内容保存到关联文件中。
+- `文件 > 另存为`：将当前活动标签的内容保存为新文件。
+
 4. 在每个标签的文本区域中编辑内容。
 5. 状态栏将显示有关光标位置和文本统计信息的信息。

@ -64,7 +68,9 @@ JNotepad(Java Notepad)是一款简约而强大的跨平台文本编辑器，旨
            <version>17.0.1</version>
        </dependency>
    <dependencies>
- ## 软件运行截图
+
+## 软件运行截图
+
 - Windows 平台
  ![Windows](screenshot/windows-1.png)
 - MacOS 平台   
--- a/docs/开发指南.md
+++ b/docs/开发指南.md
@ -1,19 +1,31 @@
 # 1. 开发流程
+
 基于**AoneFlow**开发流程，具体请阅读：[在阿里，我们如何管理代码分支？](https://developer.aliyun.com/article/573549)
+
 ## 1.1 IDEA IDE版
-###  步骤一 Fork JCNC/JNotepad或同步JCNC/JNotepad到个人仓库
+
+### 步骤一 Fork JCNC/JNotepad或同步JCNC/JNotepad到个人仓库
+
 #### 首次开发，进行Fork操作
+
 ![输入图片说明](https://foruda.gitee.com/images/1693230738686081312/d1f9178e_341872.png "屏幕截图")
+
 #### 非首次开发，进行同步操作
+
 ![输入图片说明](https://foruda.gitee.com/images/1693230711005054075/9d8adb17_341872.png "屏幕截图")

 ### 步骤二 clone个人仓库或fetch
+
 #### 首次开发，clone个人仓库
+
 ![输入图片说明](https://foruda.gitee.com/images/1693230809903750175/da0d73b5_341872.png "屏幕截图")
+
 #### 非首次开发，执行fetch
+
 ![输入图片说明](https://foruda.gitee.com/images/1693231554501661630/308a9783_341872.png "屏幕截图")

 ### 步骤三 从remote下的master分支创建本地开发分支。
+
 **特殊情况：开发依赖release分支已提交内容，或是对已提交内容进行修改，那么需要从release分支上进行拉取。**
 ![输入图片说明](https://foruda.gitee.com/images/1693231016998001511/7a6a6f3d_341872.png "屏幕截图")
 ![输入图片说明](https://foruda.gitee.com/images/1693231347247142683/17ff5fd4_341872.png "屏幕截图")
@ -23,12 +35,15 @@
 ### 步骤四 推送本地分支到远程

 ### 步骤五 发起Pull Request（PR）
+
 ![输入图片说明](https://foruda.gitee.com/images/1693232191273920333/65665291_341872.png "屏幕截图")

 **注意：目标分支选择预期要发布的release分支**

 ## 1.2 GIT命令行版本
+
 步骤一、步骤二、步骤五同1.1操作
+
 ```shell
 # 步骤三
 git fetch
@ -38,24 +53,28 @@ git push origin feature-demo
 ```

 ## 1.3 分支命名规则
-|issue类别|分支名格式|示例|
-|--------|--------|----|
-|功能/优化/文档修改|feature-issue编号|feature-I7W9LX|
-|bug fix| fix-issue编号| fix-I7W9LX|
-|代码重构|refactor-issue编号|refactor-I7W9LX|
+
+| issue类别    | 分支名格式            | 示例              |
+|------------|------------------|-----------------|
+| 功能/优化/文档修改 | feature-issue编号  | feature-I7W9LX  |
+| bug fix    | fix-issue编号      | fix-I7W9LX      |
+| 代码重构       | refactor-issue编号 | refactor-I7W9LX |

 # 2. IDEA插件配置
+
 * 安装Resource Bundle插件
  ![输入图片说明](https://foruda.gitee.com/images/1693125995274955090/9efa2d4c_341872.png "屏幕截图")
 * 安装成功后，打开i18n.properties，可以看到Resource Bundle tab
  ![输入图片说明](https://foruda.gitee.com/images/1693126057242554469/10667419_341872.png "屏幕截图")

 # Q&A
+
 Q: 本地开发时，主仓库合并了新代码，如何处理？    
 A: 继续完成本地开发，发起PR时再解决冲突。

 Q: 解决冲突步骤是什么？    
 A: 一般按如下步骤。
+
 1. 先同步主仓库
 2. 本地仓库进行fetch
 3. 本地开发分支merge/pull/rebase更新的release分支
--- a/pom.xml
+++ b/pom.xml
@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

--- a/tool/package.md
+++ b/tool/package.md
@ -1,30 +1,41 @@
 # 打包
+
 ## 准备
+
 1. 下载maven 3.8.8， [Download](https://dlcdn.apache.org/maven/maven-3/3.8.8/binaries/apache-maven-3.8.8-bin.zip)
 2. 下载GraalVM。在[GraalVM下载页](https://www.graalvm.org/downloads/#)选择Java17，操作系统后，点击Download下载。

 # Windows下基于GraalVM的打包
+
 ## 配置maven和GraalVM
+
 1. 将下载的压缩包解压到目录，例如：d:\tools\maven,D:\tools\graalvm-17\graalvm-jdk-17.0.8+9.1
 2. 配置环境变量
+
 ```
 GRAALVM_HOME=D:\tools\graalvm-17\graalvm-jdk-17.0.8+9.1
 M2_HOME=d:\tools\maven
 ```
+
 ![env.png](images%2Fenv.png)
+
 3. 配置PATH环境变量
-![path.png](images%2Fpath.png)
+   ![path.png](images%2Fpath.png)
 4. 安装visual studio build tools
-安装说明：https://www.graalvm.org/latest/docs/getting-started/windows/
-a) 下载安装程序：https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16
-b) 参考网页中的安装步骤
+   安装说明：https://www.graalvm.org/latest/docs/getting-started/windows/
+   a) 下载安装程序：https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16
+   b) 参考网页中的安装步骤
 5. 验证安装成功
-使用下面命令启动编译环境
+   使用下面命令启动编译环境
+
 ```
 cmd.exe /k F:\vs\ide\VC\Auxiliary\Build\vcvars64.bat
 ```
+
 需要把F:\vs\ide替换为本地的visual stuido安装路径。
+
 6. 进入项目tool目录，执行build.bat进行打包，生成可执行文件。
+
 ```
 build.bat
 ```