统一文案、排版的相关规范,降低团队成员之间的沟通成本,增强程序员气质。
目录
空格
漢學家稱這個空白字元為「盤古之白」,
因為它劈開了全形字和半形字之間的混沌。
另有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,
有七成的比例會在 30 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。
畢竟愛情跟書寫都需要適時地留白。
————[vinta/paranoid-auto-spacing](https://github.com/vinta/pangu.js)
中英文之间需要增加空格
错误
在LeanCloud上,数据存储是围绕
AVObject
进行的。
在 LeanCloud上,数据存储是围绕
AVObject
进行的。
正确
在 LeanCloud 上,数据存储是围绕
AVObject
进行的。
完整的用法:
在 LeanCloud 上,数据存储是围绕
AVObject
进行的。每个AVObject
都包含了与 JSON 兼容的 key-value 对应的数据。数据是 schema-free 的,你不需要在每个AVObject
上提前指定存在哪些键,只要直接设定对应的 key-value 即可。
注意:「豆瓣FM」等产品、专有名词,按照官方所定义的格式书写。
中文与数字之间需要增加空格
错误
昨天基金大跌了,损失了 3000元。
昨天基金大跌了,损失了3000元。
正确
昨天基金大跌了,损失了 3000 元。
数字与字符单位之间无需增加空格
错误
5 G 的时延可以控制在 1 ms 以内。
正确
5G 的时延可以控制在 1ms 以内。
错误
今天温度回升到了 16 ° 。
相比 2017 年的高点,目前北京的房价大约下跌了 11 %。
正确
今天温度回升到了 16°。
相比 2017 年的高点,目前北京的房价大约下跌了 11%。
全角标点与其他字符之间不加空格
错误
刚才又重金买入了 TNB ,好开心 !
正确
刚才又重金买入了 TNB,好开心!
标点符号
不重复使用标点符号
其实在快节奏的互联网下,很多时候好像大家不用更夸张的表现手法不足以说明当时的心境,但是热点与心情来得快,去得也快。往往是一直波澜不兴的人,偶尔的一声惊叹却能在心中掀起万丈惊涛。
错误
德国队竟然小组赛就被淘汰了!!
德国队竟然小组赛就被淘汰了!!!!!!!!
她刚才说「喵」??!!
她刚才说「喵」?!?!??!!
正确
德国队竟然小组赛就被淘汰了!
她刚才说「喵」?!
全角和半角
关于全角(全形)与半角(半形)符号的说明,可以参见维基百科词条『全角和半角』。
行文正常使用全角中文标点
错误
嗨! 你知道嘛? 今天前台的小姐姐跟我说 “喵” 了哎!
嗨!你知道嘛?今天前台的小姐姐跟我说”喵”了哎!
阿尔法狗 (AlphaGo) 的基本原理? MCTS!
阿尔法狗(AlphaGo)的基本原理?MCTS!
正确
嗨!你知道嘛?今天前台的小姐姐跟我说「喵」了哎!
阿尔法狗(AlphaGo)的基本原理?MCTS!
数字使用半角字符
错误
客官,这只皮卡丘只卖 1000 元。
正确
客官,这只皮卡丘只卖 1000 元。
注意:在设计稿、宣传海报中,有时为了方便对齐,是可以使用全角数字的。
完整的英文整句、特殊名词,其內容使用半角标点
错误
乔布斯那句话是怎么说的?「Stay hungry,stay foolish。」
推荐你阅读《Hackers&Painters:Big Ideas from the Computer Age》,非常的有趣。
正确
乔布斯那句话是怎么说的?「Stay hungry, stay foolish.」
推荐你阅读《Hackers & Painters: Big Ideas from the Computer Age》,非常的有趣。
名词
专有名词使用正确的大小写
大小写相关用法原属于英文书写范畴,一句话,使用正确的写法。
错误
欢迎来我的 github 主页
欢迎来我的 GITHUB 主页
欢迎来我的 Github 主页
欢迎来我的 gitHub 主页
欢迎来我的 gイんĤЦ8 主页
正确
欢迎来我的 GitHub 主页
注意:当网页中需要配合整体视觉风格而出现全部大写/小写的情形,HTML 中请使用标准的规范进行书写;并通过 text-transform: uppercase;
/text-transform: lowercase;
对表现形式进行定义。
不要使用不地道的缩写
错误
急招一位 FED,需要熟悉 Js、h5,至少理解一种框架(如 backbone、angular、RJS 等)。
正确
急招一位 FED,需要熟悉 JavaScript、HTML5,至少理解一种框架(如 Backbone.js、AngularJS、React 等)。
争议
以下用法从语法的角度来讲都是正确的。
链接之间增加空格
用法:
请 提交一个 issue 并分配给相关同事。
访问我们网站的最新动态,请 点击这里 进行订阅!
对比用法:
请提交一个 issue 并分配给相关同事。
访问我们网站的最新动态,请点击这里进行订阅!
简体中文使用直角引号
用法:
「您好,『文件洞』里的『文件』是什么意思?」
对比用法:
“您好,‘文件洞’的‘文件’是什么意思?”
谁在这样做?
网站 | 文案 | UGC |
---|---|---|
Apple 中国 | Yes | N/A |
Apple 香港 | Yes | N/A |
Apple 台湾 | Yes | N/A |
Microsoft 中国 | Yes | N/A |
Microsoft 香港 | Yes | N/A |
Microsoft 台湾 | Yes | N/A |
LeanCloud | Yes | N/A |
知乎 | Yes | 部分用户达成 |
V2EX | Yes | Yes |
SegmentFault | Yes | 部分用户达成 |
Apple4us | Yes | N/A |
豌豆荚 | Yes | N/A |
Ruby China | Yes | 标题达成 |
PHPHub | Yes | 标题达成 |
参考
工具
仓库 | 语言 |
---|---|
vinta/paranoid-auto-spacing | JavaScript |
huei90/pangu.node | Node.js |
huacnlee/auto-correct | Ruby |
sparanoid/space-lover | PHP (WordPress) |
nauxliu/auto-correct | PHP |
hotoo/pangu.vim | Vim |
sparanoid/grunt-auto-spacing | Node.js (Grunt) |
hjiang/scripts/add-space-between-latin-and-cjk | Python |