/**
 * Filename:    stdrc.cc
 * Description: 一只腊鸡的技术成长。
 * Author:      Richard Chien
 * Powered By:  PurePress & Light
 */

#include <stdrc.hh>

rc::blog

中文写作风格指南

创建于 更新于

依据其它文案排版风格指南以及自身体验总结而来,部分条目略有个人色彩。

空格

中英文之间加空格

正确示例:

在 Python 中,我们使用 class 关键字来声明类。

错误示例:

在Python中,我们使用class关键字来声明类。

在 Python中,我们使用 class关键字来声明类。

中文与数字之间加空格

正确示例:

他只用了 100 行不到的代码就实现了那个复杂的功能。

错误示例:

他只用了100行不到的代码就实现了那个复杂的功能。

数字与英文单位之间加空格、与符号单位之间不加空格

正确示例:

我有一块 512 GB 的硬盘。

今天气温 23˚C,有 70% 的可能性下雨。

错误示例:

我有一块 512GB 的硬盘。

今天气温 23 ˚C,有 70 % 的可能性下雨。

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

正确示例:

他有一台 Mac。

错误示例:

他有一台 Mac 。

中文与英文半角符号之间加空格

正确示例:

很多人都在学习 C++ 这门语言。

count-- 表示给 count 变量减 1。

错误示例:

很多人都在学习 C++这门语言。

count--表示给 count 变量减 1。

行的开头和结尾不应出现空白字符

正确示例:

这是一行文字。

错误示例:

..这是一行文字。..

(上面的「.」表示空格)

除特殊场合(如代码中)外,不应有两个或更多空格连续出现

正确示例:

我喜欢 GitHub。

错误示例:

我喜欢..GitHub。

(上面的「.」表示空格)

如果确实需要表示多个空格,用「.」代替。

示例:

「我喜欢..GitHub。」这样的格式是不对的。

链接与文字之间加空格(个人习惯)

示例:

如需下载,请点击 这里

标点、数字、符号

在中文语境下使用中文全角标点(除数学运算符)

正确示例:

你好,请问《朝花夕拾》这本书还有的卖吗?

Android Studio 从 1.3 版本开始加入了 NDK(Native Development Kit)支持。

错误示例:

你好,请问<朝花夕拾>这本书还有的卖吗?

Android Studio 从 1.3 版本开始加入了 NDK(Native Development Kit)支持.

使用半角数字

正确示例:

他拿了 1000 元。

错误示例:

他拿了1000元。

使用引号引用英文短语、句子时,引号内使用英文半角标点

正确示例:

他的座右铭是「Stay hungry, stay foolish.」。

错误示例:

他的座右铭是「Stay hungry,stay foolish。」。

使用正确的省略号和破折号

正确的省略号和破折号占两格,每格分别是「…」和「—」。使用了省略号则不宜同时使用「等等」。

正确示例:

编程语言有很多,如 C、C++、Java……

他刚刚做了一个重要的决定——辞职。

错误示例:

编程语言有很多,如 C、C++、Java…

编程语言有很多,如 C、C++、Java...

编程语言有很多,如 C、C++、Java。。。

编程语言有很多,如 C、C++、Java……等等

他刚刚做了一个重要的决定 - 辞职。

他刚刚做了一个重要的决定-辞职。

他刚刚做了一个重要的决定—辞职。

正确地使用书名号

书名、篇名、报纸名、杂志名、歌曲名、影剧名和图表名,用书名号标识,括号用作注明翻译或原文时应置于书名号外。

正确示例:

《旺达与巨像》(Shadow of the Colossus)好玩吗?

错误示例:

《旺达与巨像(Shadow of the Colossus)》好玩吗?

避免叠用叹号、问号和其它不适合叠用的标点

正确示例:

这就是你的最终态度了?

是的,我已经决定了!如果再这么下去的话……

错误示例:

这就是你的最终态度了??

是的,我已经决定了!!如果再这么下去的话。。。

在表达同时包含疑惑和感叹的语气时,可连用「?!」

示例:

这么点困难就能把我们吓倒吗?!

标示被注释的词语时,使用方头括号

示例:

【C 语言】一种通用的编程语言,广泛用于系统软件与应用软件的开发。

注意区分中文数字和阿拉伯数字的使用场景

在表示数据、编号、公历年月日时,使用阿拉伯数字;在表示农历年月日、概数,或数量较小且使用汉字数字较自然时,使用汉字数字。如果汉字数字和阿拉伯数字在书写的简洁性和辨识的清晰性两方面没有明显差异时,两者均可,但应保持全文同类情况选择相同;如果数字很大,在中文语境下,使用「万」「亿」等汉字数字单位,其余部分使用阿拉伯数字,在英文或描述 IT 相关内容的语境下,使用纯阿拉伯数字,并对四位以上的数字从右往左每隔三个数字标记一个英文半角逗号。

示例:

3 月 20 日,他跑了 20.8 km。

这段代码的第 130 行有一个错误。

今天是农历八月初八。

你可以使用「4 个月」,或「四个月」。

这个人才二三十岁,看起来却像个六十几岁的老人。

中国有约 14 亿人口。

C 语言中,一个 32 位 int 型变量可以保存最大的数字为 2,147,483,647。

可使用直角引号代替弯引号,但全文应保持一致

正确示例:

他常被人称为「冷场王」。

他问我:「『天无绝人之路』这句话是出自哪里的?」

错误示例:

他常被人称为「冷场王」。

他问我:「‘天无绝人之路’这句话是出自哪里的?」

标有引号或书名号的并列成分之间不使用顿号,若有其它成分插在引号或书名号之间则使用顿号(个人习惯)

示例:

《红楼梦》《三国演义》《西游记》《水浒传》是中国的四大名著。

李白的「白发三千丈」(《秋浦歌》)、「朝如青丝暮成雪」(《将进酒》)都是脍炙人口的诗句。

在应用/商品标题中使用英文半角标点(个人习惯)

正确示例:

Jigsaw (J 拼图)

错误示例:

Jigsaw(J 拼图)

字、词、句

使用「你」而不是「您」

除非文本的主要阅读者是上级、长辈、客户等,否则应使用「你」。

部分形近、同义词汇,固定一种写法

使用「唯一」代替「惟一」,「只需」「需要」代替「只须」「须要」(如需特别强调,使用「必须」),指代事物用「其它」,指代人用「其他」。

正确地使用「的」「地」「得」

示例:

他是一个很高的人。

他能够很快地写出优质的代码。

他跑得很快。

专有名词使用正确的书写格式

按照官方给出的格式或普遍认可的格式书写,包括空格、英文大小写等。

示例:

豆瓣FM、QQ音乐、360安全卫士、Twitter、Google+、Facebook、GitHub、JavaScript、Python、PHP、iPad Air 2、iPad mini 4、MacBook Pro 等

避免使用无实际意义或指代不清的人称代词

正确示例:

怎样看待 Google 推出的社交网络产品 Google+?

iCloud 为用户带来了什么?或:iCloud 为开发者带来了什么?

错误示例:

Google 推出了社交网络产品 Google+,大家怎么看?

iCloud 为我们带来了什么?

避免使用「我」「我们」

尤其在项目文档中,当需要表达自己做了什么事情时,最好不加主语或使用项目名作为主语。

专有名词中同时包含中英文时,在两侧加空格(个人习惯)

示例:

我经常使用 QQ音乐 听歌。

内容

避免对事物作过于主观的判断或情绪化的质疑

正确示例:

为什么中国互联网的山寨现象比较普遍?而创新很少?

错误示例:

为什么中国互联网全是山寨?

避免在未经确认的事物之上进行推演

也就是「先问是不是,再问为什么」。

正确示例:

据说 XX 公司被 XX 收购了,传言是否属实?

错误示例:

据说 XX 公司被 XX 收购了,他们为什么要卖掉公司?

避免任何带有歧视的内容

包括但不限于对民族、种族、宗教信仰、性取向、性别、文化、阶层、职业、年龄等的歧视。

全文转载需在标题和文章开头注明并给出原文链接,部分引用需在文章末尾以项目列表形式给出引用资料链接

全文转载亦包括翻译。如果不是网络资源(即没有链接),则给出原文标题和出处。

参考资料

评论