Skip to content

Commit 6469d6c

Browse files
SnailclimbSnailclimb
committed
[docs update]markdown格式规范
1 parent eb51143 commit 6469d6c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+193
-197
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ packages/*/lib/
1515
traversal-folder-replace-string.py
1616
format-markdown.py
1717
package-lock.json
18+
lintmd-config.json

‎docs/database/mysql/mysql-questions-01.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ MySQL 字段类型比较多，我这里会挑选一些日常开发使用很频
9090

9191
MySQL 中的整数类型可以使用可选的 UNSIGNED 属性来表示不允许负值的无符号整数。使用 UNSIGNED 属性可以将正整数的上限提高一倍，因为它不需要存储负数值。
9292

93-
例如， TINYINT UNSIGNED 类型的取值范围是 0 ~ 255，而普通的 TINYINT 类型的值范围是 -128 ~ 127。INT UNSIGNED 类型的取值范围是 0 ~ 4,294,967,295，而普通的 TINYINT 类型的值范围是 2,147,483,648 ~ 2,147,483,647。
93+
例如， TINYINT UNSIGNED 类型的取值范围是 0 ~ 255，而普通的 TINYINT 类型的值范围是 -128 ~ 127。INT UNSIGNED 类型的取值范围是 0 ~ 4,294,967,295，而普通的 INT 类型的值范围是 2,147,483,648 ~ 2,147,483,647。
9494

9595
对于从 0 开始递增的 ID 列，使用 UNSIGNED 属性可以非常适合，因为不允许负值并且可以拥有更大的上限范围，提供了更多的 ID 值可用。
9696

‎docs/java/basis/java-basic-questions-01.md‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ head:
2727
7. 高效性（通过 Just In Time 编译器等技术的优化，Java 语言的运行效率还是非常不错的）；
2828
8. 支持网络编程并且很方便；
2929
9. 编译与解释并存；
30-
10. ......
30+
10. ……
3131

3232
> **🐛 修正（参见：[issue#544](https://github.com/Snailclimb/JavaGuide/issues/544)）**：C++11 开始（2011 年的时候）,C++就引入了多线程库，在 windows、linux、macos 都可以使用`std::thread`和`std::async`来创建线程。参考链接：http://www.cplusplus.com/reference/thread/thread/?kw=thread
3333
@@ -70,7 +70,7 @@ JRE（Java Runtime Environment） 是 Java 运行时环境。它是运行已编
7070

7171
### 什么是字节码?采用字节码的好处是什么?
7272

73-
在 Java 中，JVM 可以理解的代码就叫做字节码（即扩展名为 `.class` 的文件），它不面向任何特定的处理器，只面向虚拟机。Java 语言通过字节码的方式，在一定程度上解决了传统解释型语言执行效率低的问题，同时又保留了解释型语言可移植的特点。所以， Java 程序运行时相对来说还是高效的（不过，和C、 C++，Rust，Go 等语言还是有一定差距的），而且，由于字节码并不针对一种特定的机器，因此，Java 程序无须重新编译便可在多种不同操作系统的计算机上运行。
73+
在 Java 中，JVM 可以理解的代码就叫做字节码（即扩展名为 `.class` 的文件），它不面向任何特定的处理器，只面向虚拟机。Java 语言通过字节码的方式，在一定程度上解决了传统解释型语言执行效率低的问题，同时又保留了解释型语言可移植的特点。所以， Java 程序运行时相对来说还是高效的（不过，和 C、 C++，Rust，Go 等语言还是有一定差距的），而且，由于字节码并不针对一种特定的机器，因此，Java 程序无须重新编译便可在多种不同操作系统的计算机上运行。
7474

7575
**Java 程序从源代码到运行的过程如下图所示**：
7676

@@ -185,7 +185,7 @@ JDK 9 引入了一种新的编译模式 **AOT(Ahead of Time Compilation)** 。
185185
- Java 的类是单继承的，C++ 支持多重继承；虽然 Java 的类不可以多继承，但是接口可以多继承。
186186
- Java 有自动内存管理垃圾回收机制(GC)，不需要程序员手动释放无用内存。
187187
- C ++同时支持方法重载和操作符重载，但是 Java 只支持方法重载（操作符重载增加了复杂性，这与 Java 最初的设计思想不符）。
188-
- ......
188+
- ……
189189

190190
## 基本语法
191191

@@ -320,7 +320,7 @@ System.out.println("左移 10 位后的数据对应的二进制字符 " + Intege
320320

321321
输出：
322322

323-
```
323+
```plain
324324
初始数据：-1
325325
初始数据对应的二进制字符串：11111111111111111111111111111111
326326
左移 10 位后的数据 -1024
@@ -384,7 +384,7 @@ System.out.println("左移 10 位后的数据对应的二进制字符 " + Intege
384384

385385
运行结果：
386386

387-
```
387+
```plain
388388
0
389389
xixi
390390
1
@@ -681,16 +681,13 @@ System.out.println(l + 1 == Long.MIN_VALUE); // true
681681
- **生存时间**：从变量在内存中的生存时间上看，成员变量是对象的一部分，它随着对象的创建而存在，而局部变量随着方法的调用而自动生成，随着方法的调用结束而消亡。
682682
- **默认值**：从变量是否有默认值来看，成员变量如果没有被赋初始值，则会自动以类型的默认值而赋值（一种情况例外:被 `final` 修饰的成员变量也必须显式地赋值），而局部变量则不会自动赋值。
683683

684-
> 问：为什么成员变量有默认值？
685-
>
686-
> 答：
687-
>
688-
> 1. 先不考虑变量类型，如果没有默认值会怎样？变量存储的是内存地址对应的任意随机值，程序读取该值运行会出现意外。
689-
>
690-
> 2. 默认值有两种设置方式：手动和自动，根据第一点，没有手动赋值一定要自动赋值。成员变量在运行时可借助反射等方法手动赋值，而局部变量不行。
691-
>
692-
> 3. 对于编译器（javac）来说，局部变量没赋值很好判断，可以直接报错。而成员变量可能是运行时赋值，无法判断，误报“没默认值”又会影响用户体验，所以采用自动赋默认值。
693-
>
684+
**为什么成员变量有默认值？**
685+
686+
1. 先不考虑变量类型，如果没有默认值会怎样？变量存储的是内存地址对应的任意随机值，程序读取该值运行会出现意外。
687+
688+
2. 默认值有两种设置方式：手动和自动，根据第一点，没有手动赋值一定要自动赋值。成员变量在运行时可借助反射等方法手动赋值，而局部变量不行。
689+
690+
3. 对于编译器（javac）来说，局部变量没赋值很好判断，可以直接报错。而成员变量可能是运行时赋值，无法判断，误报“没默认值”又会影响用户体验，所以采用自动赋默认值。
694691

695692
成员变量与局部变量代码示例：
696693

@@ -776,7 +773,7 @@ public class StringExample {
776773

777774
输出：
778775

779-
```
776+
```plain
780777
字符型常量占用的字节数为：2
781778
字符串常量占用的字节数为：13
782779
```
@@ -1022,7 +1019,7 @@ public class VariableLengthArgument {
10221019
10231020
输出：
10241021
1025-
```
1022+
```plain
10261023
ab
10271024
a
10281025
b

‎docs/java/basis/java-basic-questions-02.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ System.out.println(str1.equals(str3));
115115

116116
输出结果：
117117

118-
```
118+
```plain
119119
false
120120
true
121121
true
@@ -432,8 +432,8 @@ public boolean equals(Object anObject) {
432432

433433
> ⚠️ 注意：该方法在 **Oracle OpenJDK8** 中默认是 "使用线程局部状态来实现 Marsaglia's xor-shift 随机数生成", 并不是 "地址" 或者 "地址转换而来", 不同 JDK/VM 可能不同在 **Oracle OpenJDK8** 中有六种生成方式 (其中第五种是返回地址), 通过添加 VM 参数: -XX:hashCode=4 启用第五种。参考源码:
434434
>
435-
> - https://hg.openjdk.org/jdk8u/jdk8u/hotspot/file/87ee5ee27509/src/share/vm/runtime/globals.hpp（1127行）
436-
> - https://hg.openjdk.org/jdk8u/jdk8u/hotspot/file/87ee5ee27509/src/share/vm/runtime/synchronizer.cpp（537行开始）
435+
> - https://hg.openjdk.org/jdk8u/jdk8u/hotspot/file/87ee5ee27509/src/share/vm/runtime/globals.hpp（1127 行）
436+
> - https://hg.openjdk.org/jdk8u/jdk8u/hotspot/file/87ee5ee27509/src/share/vm/runtime/synchronizer.cpp（537 行开始）
437437
438438
```java
439439
public native int hashCode();

‎docs/java/basis/java-basic-questions-03.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ head:
4949
- `ArithmeticException`（算术错误）
5050
- `SecurityException` （安全错误比如权限不够）
5151
- `UnsupportedOperationException`(不支持的操作错误比如重复创建同一用户)
52-
- ......
52+
- ……
5353

5454
![](https://oss.javaguide.cn/github/javaguide/java/basis/unchecked-exception.png)
5555

@@ -81,7 +81,7 @@ try {
8181

8282
输出：
8383

84-
```
84+
```plain
8585
Try to do something
8686
Catch Exception -> RuntimeException
8787
Finally
@@ -117,7 +117,7 @@ public static int f(int value) {
117117

118118
输出：
119119

120-
```
120+
```plain
121121
0
122122
```
123123

@@ -142,7 +142,7 @@ try {
142142

143143
输出：
144144

145-
```
145+
```plain
146146
Try to do something
147147
Catch Exception -> RuntimeException
148148
```
@@ -219,7 +219,7 @@ catch (IOException e) {
219219
- 抛出的异常信息一定要有意义。
220220
- 建议抛出更加具体的异常比如字符串转换为数字格式错误的时候应该抛出`NumberFormatException`而不是其父类`IllegalArgumentException`。
221221
- 使用日志打印异常之后就不要再抛出异常了（两者不要同时存在一段代码逻辑中）。
222-
- ......
222+
- ……
223223

224224
## 泛型
225225

@@ -323,7 +323,7 @@ printArray( stringArray );
323323
- 自定义接口通用返回结果 `CommonResult<T>` 通过参数 `T` 可根据具体的返回类型动态指定结果的数据类型
324324
- 定义 `Excel` 处理类 `ExcelUtil<T>` 用于动态指定 `Excel` 导出的数据类型
325325
- 构建集合工具类（参考 `Collections` 中的 `sort`, `binarySearch` 方法）。
326-
- ......
326+
- ……
327327

328328
## 反射
329329

‎docs/java/basis/java-keyword-summary.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public class StaticDemo {
150150

151151
静态代码块的格式是
152152

153-
```
153+
```plain
154154
static {
155155
语句体;
156156
}
@@ -282,19 +282,19 @@ public class Test {
282282

283283
上述代码输出：
284284

285-
```
285+
```plain
286286
静态代码块！--非静态代码块！--默认构造方法！--静态方法中的内容! --静态方法中的代码块！--
287287
```
288288

289289
当只执行 `Test.test();` 时输出：
290290

291-
```
291+
```plain
292292
静态代码块！--静态方法中的内容! --静态方法中的代码块！--
293293
```
294294

295295
当只执行 `Test test = new Test();` 时输出：
296296

297-
```
297+
```plain
298298
静态代码块！--非静态代码块！--默认构造方法！--
299299
```
300300

‎docs/java/basis/proxy.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ smsService.send("java");
248248

249249
运行上述代码之后，控制台打印出：
250250

251-
```
251+
```plain
252252
before method send
253253
send message:java
254254
after method send

‎docs/java/basis/reflection.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ public class Main {
170170

171171
输出内容：
172172

173-
```
173+
```plain
174174
publicMethod
175175
privateMethod
176176
I love JavaGuide

‎docs/java/basis/spi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ SLF4J （Simple Logging Facade for Java）是 Java 的一个日志门面（接
5858

5959
新建一个 Java 项目 `service-provider-interface` 目录结构如下：（注意直接新建 Java 项目就好了，不用新建 Maven 项目，Maven 项目会涉及到一些编译配置，如果有私服的话，直接 deploy 会比较方便，但是没有的话，在过程中可能会遇到一些奇怪的问题。）
6060

61-
```
61+
```plain
6262
│ service-provider-interface.iml
6363
│
6464
├─.idea
@@ -171,7 +171,7 @@ public class Main {
171171

172172
新建项目 `service-provider` 目录结构如下：
173173

174-
```
174+
```plain
175175
│ service-provider.iml
176176
│
177177
├─.idea
@@ -290,7 +290,7 @@ public class TestJavaSPI {
290290

291291
`ServiceLoader` 是 JDK 提供的一个工具类， 位于`package java.util;`包下。
292292

293-
```
293+
```plain
294294
A facility to load implementations of a service.
295295
```
296296

‎docs/java/basis/syntactic-sugar.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ public static void main(String[] args) {
777777

778778
输出结果：
779779

780-
```
780+
```plain
781781
a == b is false
782782
c == d is true
783783
```

0 commit comments

Comments
 (0)