Koishi 文档贡献指南
术语表
- CJK：中日韩文字等
- 西文：数字、拉丁字母、希腊字母等
- 西文标点：两侧权重相同的半角标点，例如四则运算符，等号等
- 前置标点：放在其相关文本前的标点，如左括号，左引号等
- 后置标点：放在其相关文本后的标点，如冒号，句号，右引号等
中文写作和排版指南
CJK 一律使用全角书写，西文一律使用半角书写
diff
- １２３ ＡＢＣ
+ 123 ABC
- ﾋﾞﾘﾋﾞﾘ
+ ビリビリ123 ABC
ビリビリ
CJK 与西文之间一律插入一个空格
diff
- 在Python中，我们使用`class`关键字来声明类。
+ 在 Python 中，我们使用 `class` 关键字来声明类。
- 他只用了100行不到的代码就实现了那个复杂的功能。
+ 他只用了 100 行不到的代码就实现了那个复杂的功能。在 Python 中，我们使用
class关键字来声明类。他只用了 100 行不到的代码就实现了那个复杂的功能。
数字与英文单位之间加空格，与符号单位之间不加空格
diff
- 我有一块 512GB 的硬盘。
+ 我有一块 512 GB 的硬盘。
- 今天气温 23 ˚C，有 70 % 的可能性下雨。
+ 今天气温 23˚C，有 70% 的可能性下雨。我有一块 512 GB 的硬盘。
今天气温 23˚C，有 70% 的可能性下雨。
括号请使用半角书写，并按照下列规则在两侧添加空格
- 如果左括号的前一个字符不是前置标点，则在左括号前插入一个空格
- 如果右括号的后一个字符不是后置标点，则在右括号后插入一个空格
diff
- Spring 框架的一种设计思想名叫控制反转（IoC），通常以依赖注入（DI）的方式实现。
- Spring 框架的一种设计思想名叫控制反转 (IoC) ，通常以依赖注入 (DI) 的方式实现。
- Spring 框架的一种设计思想名叫控制反转(IoC)，通常以依赖注入(DI)的方式实现。
+ Spring 框架的一种设计思想名叫控制反转 (IoC)，通常以依赖注入 (DI) 的方式实现。Spring 框架的一种设计思想名叫控制反转 (IoC)，通常以依赖注入 (DI) 的方式实现。
西文标点一律使用半角书写，且在两侧添加空格的方式与括号类似
- 如果该标点与两侧的内容是一个整体，请不要添加空格
diff
- 1+2=3
- 1＋2＝3
+ 1 + 2 = 3
- Bellman - Ford 算法
+ Bellman-Ford 算法1 + 2 = 3
Bellman-Ford 算法
除上述以外的标点均使用全角，且两侧均不留空格
diff
- 他有一台 MacBook Pro.
- 他有一台 MacBook Pro 。
+ 他有一台 MacBook Pro。他有一台 MacBook Pro。
使用正确的省略号和破折号
正确的省略号和破折号占两格，每格分别是「…」和「—」。使用了省略号则不宜同时使用「等等」。
diff
- 编程语言有很多，如 C、C++、Java…
- 编程语言有很多，如 C、C++、Java...
- 编程语言有很多，如 C、C++、Java。。。
- 编程语言有很多，如 C、C++、Java……等等
+ 编程语言有很多，如 C、C++、Java……
- 他刚刚做了一个重要的决定 - 辞职。
- 他刚刚做了一个重要的决定-辞职。
- 他刚刚做了一个重要的决定—辞职。
+ 他刚刚做了一个重要的决定——辞职。编程语言有很多，如 C、C++、Java……
他刚刚做了一个重要的决定——辞职。
针对首次出现的概念，使用粗体进行强调，同时在两侧添加必要的空格
diff
- 下面介绍 TypeScript 特有的依赖合并 (Declaration Merging) 机制。
- 下面介绍 TypeScript 特有的 **依赖合并** (Declaration Merging) 机制。
+ 下面介绍 TypeScript 特有的 **依赖合并 (Declaration Merging)** 机制。下面介绍 TypeScript 特有的 依赖合并 (Declaration Merging) 机制。
强调的部分应尽量简短，对要强调的概念的补充说明建议不使用粗体
diff
- 组件的 **副作用 (触发组件外的影响)** 应声明在最前面。
+ 组件的 **副作用** (触发组件外的影响) 应声明在最前面。组件的 副作用 (触发组件外的影响) 应声明在最前面。
尽量避免在正文中使用斜体
- 斜体的汉字非常不美观，如有需求可以使用粗体 (
**)
diff
- __只要有能够拼接文件的构建系统，就把每个组件单独分成文件。__
+ **只要有能够拼接文件的构建系统，就把每个组件单独分成文件。**只要有能够拼接文件的构建系统，就把每个组件单独分成文件。
Markdown 风格指南
使用一个、两个和三个 * 分别表示斜体、粗体和粗斜体
diff
- 这是一个_斜体_；这是一个__粗体__；这是一个___粗斜体___。
+ 这是一个*斜体*；这是一个**粗体**；这是一个***粗斜体***。