文档书写规范
有研究顯示,打字的時候不喜歡在中文和英文之間加空格的人,感情路都走得很辛苦,有七成的比例會在 34 歲的時候跟自己不愛的人結婚,而其餘三成的人最後只能把遺產留給自己的貓。畢竟愛情跟書寫都需要適時地留白。
前言
我希望自己写的文章都最少能够做到:可读性高、结构良好、条理清晰、风格统一,于是在参考了一些资料后整理了一份学习笔记,就当是自己的“文档书写规范”了,供自己今后参考。
1 标题
文档中使用标题最多不超过四级。
三级标题下建议使用如下结构:
**(1) xxx**
**(2) xxx**
**(3) xxx**
(1) xxx
(2) xxx
(3) xxx
- 避免出现孤立编号。
- 标题名避免重复。
- 目录只显示二级标题、三级标题。
2 文本
- 全角中文字符与半角英文字符之间,应有一个半角空格。
- 全角中文字符与半角阿拉伯数字之间,应有一个半角空格,半角的百分号,视同阿拉伯数字。
- 数字与单位之间需要增加空格。
- 全角标点符号不用和半角符号之间留空格。
- 不使用全角空格。
- 不连续出现两个及以上空格。
- 中文使用全角标点。
- 区分“的”、“地”、“得”。
- 阿拉伯数字一律使用半角形式,不得使用全角形式。
- 数值为千位以上,应添加千分号(半角逗号)。
- 货币应为阿拉伯数字,并在数字前写出货币符号,或在数字后写出货币中文名称。
- 中文语句的标点符号,均应该采取全角符号,
- 句子末尾用括号加注时,句号应在括号之外。
- 英文句子中,并列词语之间使用半角逗号(,)分隔。
- 补充说明时,使用全角圆括号(()),括号前后不加空格。
- 表示时间时,应使用半角冒号(:)。
- 句子内部表示并列,应使用全角顿号,并列词是英语也是如此。
3 段落
- 段落开头不建议缩进,顶格开始即可。
- 引用第三方内容时,应注明出处。
- 不连续出现两行及以上空行。
- 避免“一逗到底”。
4 其他
- 文件名不得含有空格。
- 建议使用空格键而不是
tab
键对齐。 - 不混用
tab
和空格。 - 一个
tab
为四个半角空格。 - 文档目录可以通过各级标题自动生成。
参考资料
留言或评论请使用 Github Issues。