JS Guide JS Guide
首页
  • JS 部分
  • HTML 部分
  • CSS 部分
  • Vue
  • React & Angular
  • 数据结构、算法、OS
  • 计网、浏览器
  • 杂项
笔试
面试
资源
资讯
  • 关于本站
  • 更新历史
  • 贡献指南
  • 文档规范
  • 常见问题
GitHub (opens new window)
首页
  • JS 部分
  • HTML 部分
  • CSS 部分
  • Vue
  • React & Angular
  • 数据结构、算法、OS
  • 计网、浏览器
  • 杂项
笔试
面试
资源
资讯
  • 关于本站
  • 更新历史
  • 贡献指南
  • 文档规范
  • 常见问题
GitHub (opens new window)
  • 文档规范说明
  • 中文排版规范
    • 1 空格
    • 2 标点符号
    • 3 全角与半角
    • 4 专有名词
    • 5 其他
    • 参考资料
  • 代码规范
  • Markdown 规范

  • 文档规范
卡洛
2022-10-22
目录

中文排版规范

以下只是一些简单的规范。更详细的规范可以参考文末的相关资料。

# 1 空格

# 1.1 中英文之间需要添加空格

正确:

这是一份 JavaScript 面试指南。

错误:

这是一份JavaScript面试指南。

这是一份 JavaScript面试指南。

例外:部分专有名词按官方格式为准,如:

QQ音乐

# 1.2 中文与数字之间需要添加空格

正确:

今天是 2022 年 10 月 22 日。

错误:

今天是2022年10月22日。

# 1.3 数字与单位之间需要添加空格

正确:

本题执行用时 60 ms,内存消耗 41.2 MB。

错误:

本题执行用时 60ms,内存消耗 41.2MB。

例外:数字与度数单位/百分号之间不需要添加空格:

正确:

这个角度是 45°。

本题通过率为 100%。

错误:

这个角度是 45 °。

本题通过率为 100 %。

# 1.4 行内代码两侧需要添加空格

正确:

单目运算符 + 可以将后面的变量/字面量转换为 number 类型(等同于 Number() 函数)。

错误:

单目运算符+可以将后面的变量/字面量转换为number类型(等同于Number()函数)。

# 1.5 加粗、斜体、删除线两侧需要添加空格

正确:

JavaScript 是一种 弱类型 语言。

JavaScript 是一种 弱类型 语言。

JavaScript 是一种 弱类型 语言。

错误:

JavaScript是一种弱类型语言。

JavaScript是一种弱类型语言。

JavaScript是一种弱类型语言。

# 1.6 链接两侧需要添加空格

正确:

点击 这里 (opens new window) 查看更多内容。

错误:

点击这里 (opens new window)查看更多内容。

# 1.7 全角标点与上述字符之间不需要添加空格,上述字符位于首尾时不需要添加空格

正确:

通过 JS Guide,你可以更好地学习 JavaScript。

错误:

通过 JS Guide ,你可以更好地学习 JavaScript 。

例外:加粗、斜体包含标点时,两侧需要添加空格,否则不会被渲染:

正确:

说明: 本题为 LeetCode 原题。

错误:

**说明:**本题为 LeetCode 原题。

# 2 标点符号

参考 《中华人民共和国国家标准 GB/T 15834-2011 标点符号用法》 (opens new window) ,这里不再赘述。

# 3 全角与半角

# 3.1 正文使用全角标点符号,不要混排,尤其是括号

正确:

在 2022 年,Apple 公司发布的 iPhone 14 Pro 系列(包括 Pro Max)中,搭载了 A16 处理器!

错误:

在 2022 年,Apple 公司发布的 iPhone 14 Pro 系列(包括 Pro Max)中,搭载了 A16 处理器!

# 3.2 数字、英文、空格使用半角字符

正确:

JavaScript 语言的最新版本 ECMAScript 2022 于 2022 年 6 月正式发布。

错误:

JavaScript 语言的最新版本 ECMAScript 2022 于 2022 年 6 月正式发布。

# 3.3 英文整句使用半角标点符号

正确:

Atwood 定律表示:“Any application that can be written in JavaScript, will eventually be written in JavaScript.”

错误:

Atwood 定律表示:“Any application that can be written in JavaScript,will eventually be written in JavaScript。”

# 4 专有名词

一切专有名词以官方为准,并注意以下几点:

# 4.1 正确的大小写

正确:

使用 GitHub Pages 可以帮助你静态托管网站。

JavaScript 是一种弱类型语言。

错误:

使用 github pages 可以帮助你静态托管网站。

javascript 是一种弱类型语言。

# 4.2 不推荐滥用缩写,不使用不地道的缩写

正确:

本职位要求熟悉 JavaScript、TypeScript、HTML5等前端技术,并至少了解一种前端框架,如 React、Vue、Angular 等。

可以,但不推荐:

本职位要求熟悉 JS、TS、H5 等前端技术,并至少了解一种前端框架,如 React、Vue、Angular 等。

错误:

本职位要求熟悉 Js、Ts、h5 等前端技术,并至少了解一种前端框架,如 RJS、VJS、Ng 等。

# 5 其他

待补充

# 参考资料

  • 中文文案排版指北 - sparanoid (opens new window)
  • 中文文案排版细则 - Dawner (opens new window)
  • 中文技术文档写作风格指南 (opens new window)
在 GitHub 中编辑此页 (opens new window)
上次更新于: 2022/10/25 00:52:37
文档规范说明
代码规范

← 文档规范说明 代码规范→

Theme by Vdoing | Copyright © 2022-2022 Carlo | Powered by VuePress
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式