增加JCNC项目开发流程.md

增加JNotepad项目文档.md
修复文档错别字
This commit is contained in:
许轲 2023-10-02 02:27:55 +08:00
parent 7a1a799e60
commit 8c940417e5
24 changed files with 233 additions and 36 deletions

View File

@ -40,7 +40,7 @@
8. 拉取请求Pull Request
在远程仓库中创建一个拉取请求,请求将的更改合并到另一个分支。
在远程仓库中创建一个拉取请求,请求将的更改合并到另一个分支。
9. 状态Status 查看工作区和暂存区的状态。
git status
@ -91,7 +91,7 @@
- 设置用户名
```shell
git config --global user.name "的用户名"
git config --global user.name "的用户名"
```
- 确认正确设置了 Git 用户名:
@ -107,7 +107,7 @@
- 设置 Git 用户名:
```shell
git config user.name "的用户名"
git config user.name "的用户名"
```
- 确认正确设置了 Git 用户名:

View File

@ -4,16 +4,15 @@
### 新手指南
[第一次接触开源项目?](第一次接触开源项目.md)
[第一次接触开源项目?](第一次接触开源项目.md)
[Git常用命令](Git常用命令.md)
[JCNC项目开发流程](JCNC项目开发流程/JCNC项目开发流程.md)
[JCNC项目开发流程](JCNC项目开发流程/JCNC项目开发流程/JCNC项目开发流程.md)
### 项目文档
[JNotepad文档](https://gitee.com/jcnc-org/JNotepad/blob/release-v1.1.13/README.md)
### 欢迎补充和修复文档!
### 欢迎补充和修复文档!

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 10 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 70 KiB

View File

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

Before

Width:  |  Height:  |  Size: 183 KiB

After

Width:  |  Height:  |  Size: 183 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

@ -1,28 +1,28 @@
# 1. 开发流程
基于**AoneFlow**开发流程,具体请阅读:[在阿里,我们如何管理代码分支?](https://developer.aliyun.com/article/573549)
## 1.1 IDEA IDE
## 1.1 IntelliJ IDEA
### 步骤一 Fork JCNC/JNotepad或同步JCNC/JNotepad到个人仓库
#### 首次开发进行Fork操作
![输入图片说明](img/1.png "屏幕截图")
![输入图片说明](1.png "屏幕截图")
#### 非首次开发,进行同步操作
![输入图片说明](img/2.png "屏幕截图")
![输入图片说明](2.png "屏幕截图")
### 步骤二 clone个人仓库或fetch
#### 首次开发clone个人仓库
![输入图片说明](img/3.png "屏幕截图")
![输入图片说明](3.png "屏幕截图")
#### 非首次开发执行fetch
![输入图片说明](img/4.png "屏幕截图")
![输入图片说明](4.png "屏幕截图")
### 步骤三 从remote下的master分支创建本地开发分支
![输入图片说明](img/5.png "屏幕截图")
![输入图片说明](img/6.png "屏幕截图")
![输入图片说明](5.png "屏幕截图")
![输入图片说明](6.png "屏幕截图")
分支命名规则见1.3节
### 步骤四 推送本地分支到远程
### 步骤五 发起Pull RequestPR
![输入图片说明](img/7.png "屏幕截图")
![输入图片说明](7.png "屏幕截图")
**注意目标分支选择预期要发布的release分支**
@ -44,7 +44,7 @@ git push origin feature-demo
|代码重构|refactor-issue编号|refactor-I7W9LX|
# 2. IDEA插件配置
* 按照Resource Bundle插件
![输入图片说明]( img/8.png "屏幕截图")
* 安装Resource Bundle插件
![输入图片说明]( 8.png "屏幕截图")
* 安装成功后打开i18n.properties可以看到Resource Bundle tab
![输入图片说明]( img/9.png "屏幕截图")
![输入图片说明]( 9.png "屏幕截图")

View File

@ -0,0 +1,11 @@
# 开发者指南
欢迎使用 JNotepad 开发者指南。借助这些文档,您可以了解如何使用和开发 JNotepad 。
如果您是首次接触 JavaFX并希望开始编写代码请从[构建首个 JavaFx 应用](../构建首个JavaFx应用.md)教程开始。
此外,请通过查看下面的其他资源来学习 JavaFX 开发:
- [JavaFX官网](https://openjfx.io/)
- [JavaFX API](https://openjfx.io/javadoc/21/)

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB

View File

@ -0,0 +1,187 @@
# 序言
构建首个JavaFX应用的文档编写可以分为以下几个步骤。这个示例将创建一个简单的JavaFX应用程序展示一个包含 "Hello, JNotepad!" 文本的窗口。
示例JavaFX应用开发环境:
| 环境配置 | 版本号 |
|:----:|:----------------------:|
| 操作系统 | Windows 11 |
| IDE | IntelliJ IDEA 2023.2.1 |
| JDK | OpenJDK 17.0.2 |
# 步骤1准备开发环境
在开始编写JavaFX应用之前确保您已经完成以下准备工作
1. 安装Java Development Kit (JDK)确保您的计算机上安装了Java SE Development KitJDK
您可以从Oracle官网或者使用OpenJDK获取。
> 推荐使用**OpenJDK 17**及以上的**GA Releases**。
>
> - [点击下载 OpenJDK 17](https://jdk.java.net/java-se-ri/17)
> - [点击下载 OpenJDK 21](https://jdk.java.net/java-se-ri/21)
2. 安装集成开发环境IDE您可以选择使用Eclipse、**IntelliJ IDEA**、NetBeans等集成开发环境来开发JavaFX应用程序。确保IDE已经安装并配置好。
> 推荐使用**IntelliJ IDEA**,并且以**IntelliJ IDEA**作为集成开发环境。
>
> - [点击下载 IntelliJ IDEA](https://www.jetbrains.com/zh-cn/idea/)
# 步骤2创建JavaFX项目
在您的IDE中创建一个新的JavaFX项目
1. 打开IDE并选择创建一个新的JavaFX项目。
![img.png](JNotepad项目文档/img.png)
2. 配置项目名称和存储位置。
![img_1.png](JNotepad项目文档/img_1.png)
3. 点击下一步。
![img_2.png](JNotepad项目文档/img_2.png)
4. 点击创建
![img_3.png](JNotepad项目文档/img_3.png)
5. 删除初始化代码
![img_4.png](JNotepad项目文档/img_4.png)
6. 新建项目完毕
![img_7.png](JNotepad项目文档/img_7.png)
# 步骤3编写JavaFX应用程序代码
现在您可以开始编写JavaFX应用程序的代码。以下是一个简单的示例
我们把这些代码复制进项目:
MyJavaFXApp.java:
```java
package com.example.demo;
import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.control.Label;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
/**
* @author luke
*/
public class MyJavaFXApp extends Application {
@Override
public void start(Stage primaryStage) {
// 创建一个Label来显示文本
Label label = new Label("Hello, JNotepad!");
// 创建一个StackPane布局将Label置于其中
StackPane root = new StackPane();
root.getChildren().add(label);
// 创建一个Scene并将StackPane设置为根节点
Scene scene = new Scene(root, 300, 200);
// 设置主舞台的标题和Scene
primaryStage.setTitle("My JavaFX App");
primaryStage.setScene(scene);
// 显示主舞台
primaryStage.show();
}
public static void main(String[] args) {
launch(args);
}
}
```
module-info.java:
```java
module com.example.demo {
requires javafx.controls;
opens com.example.demo;
}
```
pom.xml:
```xml
<?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"
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>
<groupId>com.example</groupId>
<artifactId>Demo</artifactId>
<version>1.0-SNAPSHOT</version>
<name>Demo</name>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<junit.version>5.9.2</junit.version>
</properties>
<dependencies>
<dependency>
<groupId>org.openjfx</groupId>
<artifactId>javafx-controls</artifactId>
<version>17.0.6</version>
</dependency>
<dependency>
<groupId>org.openjfx</groupId>
<artifactId>javafx-fxml</artifactId>
<version>17.0.6</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<configuration>
<source>17</source>
<target>17</target>
</configuration>
</plugin>
<plugin>
<groupId>org.openjfx</groupId>
<artifactId>javafx-maven-plugin</artifactId>
<version>0.0.8</version>
<executions>
<execution>
<!-- Default configuration for running with: mvn clean javafx:run -->
<id>default-cli</id>
<configuration>
<mainClass>com.example.demo/com.example.demo.MyJavaFXApp</mainClass>
<launcher>app</launcher>
<jlinkZipName>app</jlinkZipName>
<jlinkImageName>app</jlinkImageName>
<noManPages>true</noManPages>
<stripDebug>true</stripDebug>
<noHeaderFiles>true</noHeaderFiles>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
```
# 步骤4运行应用程序
在IDE中右键文本编辑区,选择运行Run或者调试Debug您的JavaFX应用程序。这将启动JavaFX应用程序并显示一个窗口其中包含 "Hello, JavaFX!" 文本。
![img_6.png](JNotepad项目文档/img_6.png)
![img_8.png](JNotepad项目文档/img_8.png)
# 步骤5构建和打包
目前为止您的JavaFX应用程序编写完成您可以构建它并打包到目标平台分发。
[构建和打包(构建中...)]()
# 总结
完成以上步骤后您就成功构建了一个简单的JavaFX应用程序。您可以根据项目的需求进行扩展和改进添加更多的UI元素和功能。希望这份文档可以帮助您入门JavaFX应用程序的开发。

View File

@ -9,11 +9,11 @@
在开始之前,了解一些基本概念将非常有帮助:
* 版本控制系统如Git 版本控制允许跟踪代码的变化,方便协作和恢复历史状态。
* 版本控制系统如Git 版本控制允许跟踪代码的变化,方便协作和恢复历史状态。
* 代码仓库: 这是存储项目代码的地方通常位于GitHub、Gitee、GitLab等平台上。
* 分支: 分支是在代码仓库上进行独立开发的方式,它允许在不影响主要代码的情况下进行实验和修改。
* 分支: 分支是在代码仓库上进行独立开发的方式,它允许在不影响主要代码的情况下进行实验和修改。
* 提交: 提交是对代码所做更改的快照,它包含有关更改内容的说明。
* 拉取请求Pull Request 这是将的更改合并到主代码库的方式,维护者和其他贡献者可以审查并提供反馈。
* 拉取请求Pull Request 这是将的更改合并到主代码库的方式,维护者和其他贡献者可以审查并提供反馈。
[Git常见命令](Git常用命令.md)
@ -21,15 +21,15 @@
在参与开源项目之前,考虑以下几个标准来选择合适的项目:
* 兴趣领域: 选择你感兴趣的项目,这将激发你的动力。
* 兴趣领域: 选择您感兴趣的项目,这将激发您的动力。
* 项目活跃度: 选择一个活跃的项目,这意味着更多的合作机会和反馈。
* 社区支持: 寻找一个友好和包容的社区,可以帮助更好地融入。
* 社区支持: 寻找一个友好和包容的社区,可以帮助更好地融入。
## 4. 准备工作
在开始贡献之前,进行一些准备工作:
* 安装Git 学习如何安装和配置Git以便可以管理代码。
* 设置开发环境: 安装所需的依赖项和开发工具,确保可以顺利开展工作。
* 安装Git 学习如何安装和配置Git以便可以管理代码。
* 设置开发环境: 安装所需的依赖项和开发工具,确保可以顺利开展工作。
## 5. 了解项目
@ -44,16 +44,16 @@
* 克隆仓库: 使用Git克隆项目仓库到本地。
* 创建分支: 基于主分支创建自己的分支,以便进行更改。
* 进行修改: 进行的更改,保持提交小而有针对性。
* 提交代码: 提交你的更改,写清楚提交信息,解释你所做的事情。
* 创建拉取请求: 将的更改提交到主仓库,请求审查和合并。
* 进行修改: 进行的更改,保持提交小而有针对性。
* 提交代码: 提交您的更改,写清楚提交信息,解释您所做的事情。
* 创建拉取请求: 将的更改提交到主仓库,请求审查和合并。
## 7. 与社区互动
与社区保持积极互动:
* 提问技巧: 学习如何恰当地提出问题,确保得到有效的帮助。
* 参与讨论: 在问题跟踪、论坛等地方参与讨论,分享的见解。
* 参与讨论: 在问题跟踪、论坛等地方参与讨论,分享的见解。
## 8. 贡献的不同方式
@ -67,7 +67,7 @@
## 9. 解决问题和冲突
在合作中遇到问题是正常的,学会妥善处理:
* 自学解决问题: 尝试自己找到解决方案,提升的技能。
* 自学解决问题: 尝试自己找到解决方案,提升的技能。
* 与他人合作: 如果遇到难题,与社区成员一起合作解决。
## 10. 持续学习和发展
@ -76,11 +76,11 @@
* 学习资源: 利用在线教程、文档、书籍等提升技能。
* 持续改进: 不断反思,寻找提升贡献和合作的方法。
## 11. 分享的经验
## 11. 分享的经验
通过分享的开源经验,激励其他新人参与:
* 写博客: 记录的学习和贡献经历,分享给他人。
* 演讲和讲座: 在技术活动上分享的开源旅程。
通过分享的开源经验,激励其他新人参与:
* 写博客: 记录的学习和贡献经历,分享给他人。
* 演讲和讲座: 在技术活动上分享的开源旅程。
## 12. 法律和道德注意事项
@ -96,6 +96,6 @@
## 14. 鼓励和支持
最重要的是,鼓励和支持的努力:
* 参与乐趣: 记住是为了学习和乐趣而参与,不必过于压力。
最重要的是,鼓励和支持的努力:
* 参与乐趣: 记住是为了学习和乐趣而参与,不必过于压力。
* 成就感: 每一次贡献都是一个值得庆祝的成就,不管大小。