在 GitHub 存放的本标准已经过时, 且本仓库将不再更新. 请前往此处获取最新版本 https://www.peaksol.org/articles/text-formatting-guidelines.html.

这是一套适用于中文文档的编写风格规范.

• 目录
• 语言文字处理
  • 保持中文与英文的间距
  • 中文句子中的英文单词应总是使用原形
  • 英文中的专有名词应保持规范大小写
• 标点符号
  • 使用半角标点符号
  • 保持标点与文字的间距
• 数
  • 表示数值
  • 表示数值范围
  • 保持数与文字的间距
• 参考文献

❌ 错误示例:

HTML常与CSS和JavaScript一起被众多网站用于设计网页.

✔️ 正确示例:

HTML 常与 CSS 和 JavaScript 一起被众多网站用于设计网页.

❌ 错误示例:

许多现代 CPUs 都有集成电源管理模块.

✔️ 正确示例:

许多现代 CPU 都有集成电源管理模块.

❌ 错误示例:

最新改动的代码已经 pushed 到了主分支.

✔️ 正确示例:

最新改动的代码已经 push 到了主分支.

❌ 错误示例:

连 powershell 都不会用, 你就不会 google 一下吗?

✔️ 正确示例:

连 PowerShell 都不会用, 你就不会 Google 一下吗?

无论是在中文还是英文语句中, 一律使用半角标点, 不使用全角标点.

❌ 错误示例:

因为历史原因，我们的文档，即 Graia Document 目前急需改进和完善，如果有意愿，欢迎提起 Pull Request。

✔️ 正确示例:

因为历史原因, 我们的文档, 即 Graia Document 目前急需改进和完善, 如果有意愿, 欢迎提起 Pull Request.

1. 对于除引号和括号外的每一个标点符号, 其后如果有文字, 则应在这个标点之后增加一个空格的间隔.

   ❌ 错误示例:

   在 JavaScript 中,被称为 this 的事物,指的是拥有该 JavaScript 代码的对象.
   

   ✔️ 正确示例:

   在 JavaScript 中, 被称为 this 的事物, 指的是拥有该 JavaScript 代码的对象.
   

2. 对于引号和括号, 其内两侧无需增加空格; 外两侧一般需要增加一个空格.

   ❌ 错误示例:

   Visual Studio Code(简称 VS Code)是一个由支持多平台的免费代码编辑器.
   Visual Studio Code (简称 VS Code)是一个由支持多平台的免费代码编辑器.
   Visual Studio Code(简称 VS Code) 是一个由支持多平台的免费代码编辑器.
   Visual Studio Code ( 简称 VS Code ) 是一个由支持多平台的免费代码编辑器.
   

   ✔️ 正确示例:

   Visual Studio Code (简称 VS Code) 是一个由支持多平台的免费代码编辑器.
   

   在前两个示例中, 括号的前后以及内部混杂了中英文, 这时一般需要在括号前后加上一个空格.

   ✔️ 正确示例:

   编译器可以将 TS 编译为可以在任何 JS 引擎 (如浏览器) 中执行的标准 JS.
   

   ✔️ 正确示例:

   编译器可以将 TS 编译为可以在任何 JS 引擎(如浏览器)中执行的标准 JS.
   

   在前两个示例中, 括号前后以及内部都是中文, 这时在括号前后即使不空格看起来也比较合适.

1. 表示数值, 应该使用半角的阿拉伯数字(以下简称数字).
2. 在数值中, 一般计量单位与数字之间应有一个空格的间隔.
3. 在数值中, 度分秒 (° ′ ″), 百分号 (%), 货币符号 ($ ¥ €...) 与数字之间无需空格.

1. 表示数值范围, 使用 "-" 连接两个数字. 连字符前后无空格.
2. 在数值范围中, 一般计量单位仅在第二个数字之后出现一次(除非两个数字的计量单位不同), 并应与数字之间有一个空格的间隔.
3. 在数值范围中, 度分秒 (° ′ ″), 百分号 (%), 货币符号 ($, ¥, €...) 应该在每个数字都出现一次, 并与数字之间无需空格.

本规范的第一条在此仍然适用. 这意味着当数值或数值范围被插入在文本中时, 仍然需要保持中英文的间距.

此外, 阿拉伯数字与文字之间同样需要有一个空格的间隔.

❌ 错误示例:

此服务器响应时间不会超过1000 ms, 一般100-500 ms是正常响应时间.
此服务器响应时间不会超过1000 ms, 一般100-500 ms 是正常响应时间.
此服务器响应时间不会超过 1000 ms, 一般 100-500 ms是正常响应时间.

✔️ 正确示例:

此服务器响应时间不会超过 1000 ms, 一般 100-500 ms 是正常响应时间.

• How to Write About Ranges by Mark Nichol