混合排版规则¶
科技文档中,经常出现中文和英文的混合排版,统一的排版用法,可以降低团队成员之间的沟通成本。
标点符号¶
中文语句的标点符号,均应该使用全角符号。如果整句为英文,则该句使用英文/半角标点。标点符号不得出现在一行之首。
句号¶
中文语句的结尾处应该用全角句号,句子末尾用括号加注时,句号应在括号之外。
错误示例:
关于文件的输出,请参照第 1.3 节(见第 26 页。)
正确示例:
关于文件的输出,请参照第 1.3 节(见第 26 页)。
逗号¶
逗号表示句子内部的一般性停顿,避免“一逗到底”,即整个段落除了结尾,全部停顿都使用逗号。
顿号¶
句子内部的并列词,应该用全角顿号分隔,而不用逗号,即使并列词是英语也是如此。
错误示例:
我最欣赏的科技公司有 Google, Facebook, 腾讯, 阿里和百度等。
中文句子内部的并列词,最后一个使用(和)来连接,使句子读起来更加连贯,下面两个句子都可以,第二个更优。
正确示例:
我最欣赏的科技公司有 Google、Facebook、腾讯、阿里,以及百度等。
我最欣赏的科技公司有 Google、Facebook、腾讯、阿里和百度等。
分号¶
分号表示复句内部并列分句之间的停顿。
引号¶
引用时,应该使用全角双引号,注意前后双引号不同。
例句:
许多人都认为客户服务的核心是“友好”和“专业”。
引号里面还要用引号时,外面一层用双引号,里面一层用单引号,注意前后单引号不同。
例句:
鲍勃解释道:“我要放音乐,可萨利说,‘不行!’。”
括号¶
全角圆括号常用于补充说明内容。
例句:
请确认所有的连接(电缆和接插件)均安装牢固。
冒号¶
全角冒号常用在需要解释的词语后边,引出解释和说明。
例句:
请确认以下几项内容:时间、地点、活动名称和来宾数量。
表示时间时,应使用半角冒号。
例句:
早上 8:00
省略号¶
省略号表示语句未完、或者语气的不连续,不要使用。。。或...等非标准形式。
错误示例:
我们为会餐准备了香蕉、苹果、梨…等各色水果。
正确示例:
我们为会餐准备了各色水果,有香蕉、苹果、梨⋯⋯
我们为会餐准备了香蕉、苹果、梨等各色水果。
感叹号¶
文档中应该使用平静的语气叙述,尽量避免使用感叹号(!)。
破折号¶
破折号一般用于进一步解释。破折号应占两个汉字的位置,如果破折号本身只占一个汉字的位置,那么前后应该留出一个半角空格。
例句:
直觉——尽管它并不总是可靠的——告诉我,这事可能出了些问题。
例句:
直觉 — 尽管它并不总是可靠的 — 告诉我,这事可能出了些问题。
连接号¶
连接号用于连接两个类似的词。以下场合应该使用直线连接号,占一个半角字符的位置。
两个名词的复合
图表编号
例句:
氧化-还原反应
例句:
图 1-1
中文标点使用全角¶
全角是指一个字符占用两个标准字符位置的状态,汉字字符和中文的特殊字符都是全角字符。
错误示例:
嗨! 你知道嘛? 今天前台的小妹跟我说 "喵" 了哎!
嗨!你知道嘛?今天前台的小妹跟我说"喵"了哎!
核磁共振成像 (NMRI) 是什么原理都不知道? JFGI!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
正确示例:
嗨!你知道嘛?今天前台的小妹跟我说「喵」了哎!
核磁共振成像(NMRI)是什么原理都不知道?JFGI!
英文整句中使用半角标点¶
半角是一个字符占用一个标准字符的位置,包括英文字母、罗马数字、西方语言的符号等。
错误示例:
乔布斯那句话是怎么说的?「Stay hungry,stay foolish。」
推荐你阅读《Hackers&Painters:Big Ideas from the Computer Age》,非常的
有趣。
正确示例:
乔布斯那句话是怎么说的?「Stay hungry, stay foolish.」
推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》,非常的
有趣。
不重复使用标点符号¶
重复使用标点符号,只能起到一定的强调作用。但在文档中,应该使用中正的表述。
错误示例:
德国队竟然战胜了巴西队!!
德国队竟然战胜了巴西队!!!!!!!!
她竟然对你说「喵」??!!
她竟然对你说「喵」?!?!??!!
正确示例:
德国队竟然战胜了巴西队!
她竟然对你说「喵」?!
数值¶
一个量用数目表示出来的多少,叫做这个量的数值。把数字写在位数上,才表示一定的数值。
半角数字¶
阿拉伯数字一律使用半角形式,不得使用全角形式。
错误示例:
这件商品的价格是1000元。
正确示例:
这件商品的价格是 1000 元。
货币¶
货币应为阿拉伯数字,并在数字前写出货币符号,或在数字后写出货币中文名称。
$1000
1000 美元
数值范围¶
表示数值范围时,用波浪线连接。带有单位或百分号时,两个数字建议都要加上单位或百分号。
132kg~234kg
67%~89%
变化程度的表示法¶
数字的增加要使用“增加了”、“增加到”。“了”表示增量,“到”表示定量。
增加到过去的两倍
(过去为一,现在为二)
增加了两倍
(过去为一,现在为三)
数字的减少要使用“降低了”、“降低到”。“了”表示增量,“到”表示定量。
降低到百分之八十
(定额是一百,现在是八十)
降低了百分之八十
(原来是一百,现在是二十)
提示
不能用“降低 N 倍”或“减少 N 倍”的表示法,要用“降低百分之几”或“减少百分之几”。因为减少(或降低)一倍表示数值原来为一百,现在等于零。
英语专有名词¶
专有名词是名词的一种,表示特定的、独一无二的人或物(人名、地名、国家名、公司名),与普通名词相对。
专有名词使用正确的大小写¶
专有名词使用正确的大小写属于英文书写范畴,在这里只对部分易错用法进行简述。
错误示例:
使用 github 登录
使用 GITHUB 登录
使用 Github 登录
我们的客户有 github、foursquare、microsoft corporation、google、facebook.
我们的客户有 GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK.
我们的客户有 Github、FourSquare、MicroSoft Corporation、Google、FaceBook.
正确示例:
使用 GitHub 登录
我们的客户有 GitHub、Foursquare、Microsoft Corporation、Google、Facebook.
不使用非规范的缩写¶
非规范化简称是指临时性的简称,在文档中不能直接使用,而应当先作出说明,即第一次用全称,并注明简称。
错误示例:
我们需要一位熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)
的 FED。
正确示例:
我们需要一位熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、
AngularJS、React 等)的前端开发者。
空格¶
适当的空格可以更好的传达信息内容,美化排版。
中文与英文、数字之间添加空格¶
英文、数字和中文之间添加空格,可以提升文档的可读性。
错误示例:
在LeanCloud上,数据存储是围绕AVObject进行的。
在 LeanCloud上,数据存储是围绕AVObject 进行的。
今天出去买菜花了 300元。
今天出去买菜花了300元。
正确示例:
在 LeanCloud 上,数据存储是围绕 AVObject 进行的。
每个 AVObject 都包含了与 JSON 兼容的 key-value 对应的数据。
今天出去买菜花了 300 元。
提示
产品名词包含中英文组合时,使用时按照官方所定义的格式书写,例如:「豆瓣FM」。
数字与单位之间不添加空格¶
数字与单位作为一个整体,中间不应该添加空格。
正确示例:
我家的光纤入户宽带有 10Gbps,SSD 一共有 10TB。
错误示例:
我家的光纤入户宽带有 10 Gbps,SSD 一共有 20 TB。
另外,度/百分比与数字之间不需要添加空格:
错误示例:
今天是 39 ° 的高温。
新 MacBook Pro 有 15 % 的 CPU 性能提升。
正确示例:
今天是 39° 的高温。
新 MacBook Pro 有 15% 的 CPU 性能提升。
全角标点与英文之间不添加空格¶
全角标点虽然属于中文,但是不应在之间添加空格。
错误示例:
刚刚买了一部 iPhone ,好开心!
正确示例:
刚刚买了一部 iPhone,好开心!