-
Notifications
You must be signed in to change notification settings - Fork 687
《Using Swift with Cocoa and Objective C》校对要求
ChildhoodAndy edited this page Jun 12, 2014
·
1 revision
1、将术语按照术语表翻译,并在术语之后附上术语的英文原文,例如:附属脚本(subscript)
,中文括号。
2、每篇文章的大标题下面添加分割线,也就是说每篇文章的文章标题下添加分割线,例如:
# 基本运算符
-----------------
3、原文中的experiment
和note
统一成经验
和注意
,格式如下:
>注意:
扩展可以添加新的计算属性,但是不可以添加存储属性,也不可以向已有属性添加属性观测器(property observers)。
注意两点:冒号是中文冒号;第一行和下面的内容之间不要有空行,否则格式会出错。
4、每篇文章的开头都添加一个目录,内容为本页的一级标题,比如扩展
这篇的开头如下:
#扩展(Extensions)
----
本页包含内容:
- [扩展语法(Extension Syntax)](#xxxxxxxx)
- [计算属性(Computed Properties)](#yyyyyyy)
- 构造器(Initializers)
- 方法(Methods)
- 下标(Subscripts)
- 嵌套类型(Nested Types)
*扩展*就是向一个已有的类(以下省略)
每条内容之后是否要添加英文原文请自行决定,常见的比如类
,结构体
这样不影响理解的可以忽略英文原文。理解起来有困难的比如附属脚本
,可选类型
等等请添加原文。
每条内容请添加链接,方便读者直接点击定位。添加链接的方式参考第8条。
5、校对时候注意变量名、数字是否与原文一致,这些容易打错
6、校对时注意是否有错别字
7、如果文中有中英文混杂的情况,中文和英文之间要添加一个空格,如果英文和符号相连则不添加空格,如果英文被包裹在行内代码格式中也不用添加,看例子:
这个 getter 的作用是 ←注意这里两边都要添加空格
所以要使用 getter。 ←注意这里只有左边添加了空格
这个变量名是`test` ←注意两边都不需要加空格
8、关于章节跳转的问题,由于markdown是可以内嵌HTML的,所以可以这样处理: 首先,在每个小节前面加一个锚记:
<a name="break_statement"></a>
### Break 语句
然后,如果是在本页内,需要跳转的话:
请参考[Break 语句](#break_statement)。
锚记的name采用目标标题的英文名,空格用下划线代替,并转换成小写。
9、除了代码中的标点,文中其他标点符号一律使用中文标点。
10、请将代码注释翻译成中文