跳到主要内容

中文文档排版指南

· 阅读需 5 分钟
程序员老熊

编制此排版指南的目的是统一和优化相关中文文案排版格式,降低用户阅读成本,增强网站气质,提升品牌影响力。

空格

「有研究显示,打字时候不喜欢在中文和英文之间加空格的人,感情路都走得很辛苦。有七成的比例会在 34 岁的时候跟自己不爱的人结婚,而其余三成的人最后只能把遗产留给自己的猫。毕竟爱情跟书写都需要适时地留白。」摘录自 vinta/pangu.js

中英文之间增加空格

正确

盘古开发框架基于 Apache-2.0 协议开源发布,且是免费的。

错误

盘古开发框架基于Apache-2.0协议开源发布,且是免费的。

中文与数字之间增加空格

正确

盘古开发框架在 GitEE 网站上已经有 2500 个 Stars 了。

错误

盘古开发框架在 GitEE 网站上已经有2500个 Stars 了。

数字与单位之间增加空格

正确

我的计算机有 16 GB 内存和 512 GB 固态存储。

错误

我的计算机有 16GB 内存和 512GB 固态存储。

链接与字符之间增加空格

正确

通过我们的 开发者社区 寻求更多帮助。

错误

通过我们的开发者社区寻求更多帮助。

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

正确

我自从用上了 Manjaro Linux,再也不用面对 Windows 恶心的蓝屏了。

错误

我自从用上了 Manjaro Linux ,再也不用面对 Windows 恶心的蓝屏了。

标点符号

不重复使用标点符号

正确

大熊,你的程序怎么又出 bug 了?

大熊尽然说:让我重启电脑试试?!

错误

大熊,你的程序怎么又出 bug 了???

大熊尽然说:让我重启电脑试试?!!

中文使用全角标点

正确

嗨!你知道吗?今天前台的小妹跟我说「喵」了哎!

错误

嗨! 你知道嘛? 今天前台的小妹跟我说 “喵” 了哎!

英文使用半角标点

正确

乔布斯那句话是怎么说的?「Stay hungry, Stay foolish.」

错误

乔布斯那句话是怎么说的?「Stay hungry,Stay foolish。」

名词

使用正确的大小写

大小写相关用法原属于英文书写范畴,但部分专有名词以其官方书写规范为准。(如:GitEE、GitHub、PanGu Dev Framework等)

正确

盘古开发框架(PanGu Dev Framework)的代码托管到了国内 Gitee 和 国外 GitHub 平台。

错误

盘古开发框架(Pangu Dev Framework)的代码托管到了国内 gitee 和 国外 Github 平台。

不使用不地道的缩写

正确

我们需要一位熟悉 JavaScript、HTML5、Element Plus 和 PanGu Dev Framework 的全栈开发者。

错误

我们需要一位熟悉 Js、h5、element+ 和 PGDF 的全栈开发者。

其它

段首不缩进

正确

盘古开发框架是完全独立于 Spring Cloud 生态的一套轻量灵活、成熟可靠的工业级分布式微服务开发和治理框架(兼容垂直单体分层架构)。它基于 Apache-2.0 协议开源发布,且是免费的。

错误

        盘古开发框架是完全独立于 Spring Cloud 生态的一套轻量灵活、成熟可靠的工业级分布式微服务开发和治理框架(兼容垂直单体分层架构)。它基于 Apache-2.0 协议开源发布,且是免费的。

参考文献