文档书写规范

文档书写规范

最后修改时间:2 months ago

# 中英文之间需要增加空格

正确:

在 LeanCloud 上,数据存储是围绕 AVObject 进行的。

错误:

在LeanCloud上,数据存储是围绕AVObject进行的。 在 LeanCloud上,数据存储是围绕AVObject 进行的。

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

正确:

今天出去买菜花了 5000 元。

错误:

今天出去买菜花了 5000元。
今天出去买菜花了5000元。

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

正确:

我家的光纤入屋宽带有 10 Gbps,SSD 一共有 20 TB

错误:

我家的光纤入屋宽带有 10Gbps,SSD 一共有 20TB

例外:

度 / 百分比与数字之间不需要增加空格: 10% 、 30° 、 30

# 加亮加粗斜体链接两侧增加空格

正确:

请提交一个 issue 并分配给相关同事。
我有一个 西瓜
我有一个 西瓜 我有一个 西瓜 错误:

请提交一个issue并分配给相关同事。
我有一个西瓜
我有一个 西瓜 我有一个西瓜

# 全角标点与其他字符之间不加空格

正确:

刚刚买了一部 iPhone好开心!

错误:

刚刚买了一部 iPhone 好开心!
刚刚买了一部 iPhone 好开心!

# 不重复使用标点符号

正确:

德国队竟然战胜了巴西队
她竟然对你说「喵」?!

错误:

德国队竟然战胜了巴西队!!
德国队竟然战胜了巴西队???!!!!

# 正确使用半角和全角

英文采用英文半角标点符号,中文采用中文全角标点符号(一般输入法只要指定中英文符号即可),数字采用半角字符

正确:

你好啊
核磁共振成像NMRI是什么原理都不知道
Stay hungry,stay foolish.
145

错误:

!你好啊
Stay hungrystay foolish
145

# 专有名词使用约定通用的大小写

正确:

GitHub、Microsoft Corporation、Google、Facebook, Inc.

错误:

github、microsoft corporation、google、facebook, inc.

# 勿使用容易歧义或者未约定成俗的缩写

正确:

我们需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、AngularJS、React 等)的前端开发者。

错误:

我们需要一位熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)的 FED。

# 使用直角引号

正确:

「老师,『有条不紊』的『紊』是什么意思?」

错误:

“老师,‘有条不紊’的‘紊’是什么意思?”

- 全文完 -

留下一条留言?
默认颜色

主题颜色

标准颜色

更多颜色...