Skip to content

Commit 9ccf22b

Browse files
S1ngS1nghuluoyang
S1ngS1ng
authored and
huluoyang
committed
更新：翻译格式与建议 (#37)
* Update style guide, fixing format issue, adding anchor link in CONTRIBUTING.md and adding content * Add em-dash style guide * Add two more rules
1 parent 2d78c22 commit 9ccf22b

File tree

2 files changed

+173
-41
lines changed

2 files changed

+173
-41
lines changed

‎CONTRIBUTING.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# 翻译格式与注意事项
2+
请前往[翻译格式与建议](./style-guide.md)
3+
14
# 关于 git 和 github
25
## 常用词汇
36
- repo：代码仓库

‎style-guide.md‎

Lines changed: 170 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,69 @@
1818

1919
<details><summary>示例</summary>
2020

21-
:smiley: `现在我们开始学习 CSS`
22-
:slightly_frowning_face: `现在我们开始学习　CSS`
23-
:slightly_frowning_face: `现在我们开始学习ＣＳＳ`
21+
:smiley: `现在我们开始学习 CSS`
22+
:slightly_frowning_face: `现在我们开始学习　CSS`
23+
:slightly_frowning_face: `现在我们开始学习ＣＳＳ`
2424

2525
</details>
2626

2727
2. 翻译中应使用全角标点（引号除外）。
2828

2929
<details><summary>示例</summary>
3030

31-
:smiley: `我们需要写一个函数，让它返回这两个数字间所有数字（包含这两个数字）的总和。`
32-
:slightly_frowning_face: `我们需要写一个函数,让它返回这两个数字间所有数字(包含这两个数字)的总和.`
31+
:smiley: `我们需要写一个函数，让它返回这两个数字间所有数字（包含这两个数字）的总和。`
32+
:slightly_frowning_face: `我们需要写一个函数,让它返回这两个数字间所有数字(包含这两个数字)的总和.`
3333

3434
</details>
3535

3636
3. 引号的使用由引用内容决定。若引用内容全部为半角，则选用英文引号 `""`；若引用内容包含中文，则选用中文引号 `“”`。由于引号均为半角，如果引号前后为全角字符（标点除外），则需要添加空格。
3737

3838
<details><summary>示例</summary>
3939

40-
:smiley: `请使用 “弹性盒子”（flexbox）调整元素的布局。`
41-
:smiley: `在 package.json 文件中应该有 "mongodb" 依赖`
42-
:slightly_frowning_face: `请使用"弹性盒子"（flexbox）调整元素的布局。`
40+
:smiley: `请使用 “弹性盒子”（flexbox）调整元素的布局。`
41+
:smiley: `在 package.json 文件中应该有 "mongodb" 依赖`
42+
:slightly_frowning_face: `请使用"弹性盒子"（flexbox）调整元素的布局。`
4343

4444
</details>
4545

46-
4. 应保留代码中的英文标点。
46+
4. 破折号应使用两个 em dash，即 `——`，且两边不需要添加空格。
4747

4848
<details><summary>示例</summary>
4949

50-
:smiley: `使用<code>Math.min()</code>来获取两数中较小的数。`
51-
:slightly_frowning_face: `使用<code>Math。min（）</code>来获取两数中较小的数。`
50+
:smiley: `有一种更好的方法——使用<code>repeat</code>。`
51+
:slightly_frowning_face: `有一种更好的方法 —— 使用<code>repeat</code>。`
52+
:slightly_frowning_face: `有一种更好的方法————使用<code>repeat</code>。`
5253

5354
</details>
5455

55-
5. 块级引用（blockquote）、代码块（pre）、题目 `contents` 字段里的注释部分，若不翻译则保留原符号；若需要翻译则改用全角符号。
56+
5. 省略号应使用 `……`，或在结尾添加 `等`。
57+
58+
<details><summary>示例</summary>
59+
60+
:smiley: `前端开发的相关技术很多，比如 HTML、CSS、JavaScript……`
61+
:smiley: `前端开发的相关技术很多，比如 HTML、CSS、JavaScript 等`
62+
63+
</details>
64+
65+
6. 相同的标点不应连续使用。
66+
67+
<details><summary>示例</summary>
68+
69+
:smiley: `今天真开心！`
70+
:slightly_frowning_face: `今天真开心！！！`
71+
72+
</details>
73+
74+
7. 应保留代码中的英文标点。
75+
76+
<details><summary>示例</summary>
77+
78+
:smiley: `使用<code>Math.min()</code>来获取两数中较小的数。`
79+
:slightly_frowning_face: `使用<code>Math。min（）</code>来获取两数中较小的数。`
80+
81+
</details>
82+
83+
8. 块级引用（blockquote）、代码块（pre）、题目 `contents` 字段里的注释部分，若不翻译则保留原符号；若需要翻译则改用全角符号。
5684

5785
### 结尾标点
5886
1. 题目的描述性文字，需要在结尾添加标点。
@@ -64,46 +92,55 @@
6492

6593
<details><summary>示例</summary>
6694

67-
:smiley: `为下列项目添加 CSS 属性`
68-
:smiley: `返回值是一个长度为 2 的数组`
69-
:slightly_frowning_face: `JavaScript是一种语言`
95+
:smiley: `为下列项目添加 CSS 属性`
96+
:smiley: `返回值是一个长度为 2 的数组`
97+
:slightly_frowning_face: `JavaScript是一种语言`
98+
99+
</details>
100+
101+
2. 半角字母与数字之间，不必**额外补充**空格。
102+
103+
<details><summary>示例</summary>
104+
105+
:smiley: `CSS3`
106+
:slightly_frowning_face: `CSS 3`
70107

71108
</details>
72109

73-
2. 全角符号的两边不应有空格。相应地，半角字符与全角符号之间也不应添加空格。
110+
3. 全角符号的两边不应有空格。相应地，半角字符与全角符号之间也不应添加空格。
74111

75112
<details><summary>示例</summary>
76113

77-
:smiley: `它接收一个查询的 document（一个 JSON 对象）作为参数。`
78-
:smiley: `使用弹性盒子（flexbox）`
79-
:slightly_frowning_face: `使用弹性盒子（ flexbox ）`
80-
:slightly_frowning_face: `它的值应为 10 。`
114+
:smiley: `它接收一个查询的 document（一个 JSON 对象）作为参数。`
115+
:smiley: `使用弹性盒子（flexbox）`
116+
:slightly_frowning_face: `使用弹性盒子（ flexbox ）`
117+
:slightly_frowning_face: `它的值应为 10 。`
81118

82119
</details>
83120

84-
3. HTML 标签
121+
4. HTML 标签
85122
1. `<br>` 之后不添加空格。
86123

87124
<details><summary>示例</summary>
88125

89-
:smiley: `注意<br>以下代码……`
126+
:smiley: `注意<br>以下代码……`
90127

91128
</details>
92129

93130
2. 行内元素如 `<a>`、`<b>`、`<dfn>`、`<strong>`，是否加空格取决于标签与外面文本，添加规则参考上文[空格 - 1](#空格)，元素中的内容也应按此标准添加。
94131

95132
<details><summary>示例</summary>
96133

97-
:smiley: `请参考 <a href='xxx'>Mongoose 文档</a>获取帮助。`
98-
:slightly_frowning_face: `父级元素叫做<dfn>container</dfn>`
134+
:smiley: `请参考 <a href='xxx'>Mongoose 文档</a>获取帮助。`
135+
:slightly_frowning_face: `父级元素叫做<dfn>container</dfn>`
99136

100137
</details>
101138

102139
3. `<code>` 标签，无论全半角，任何情况都不添加空格。
103140

104141
<details><summary>示例</summary>
105142

106-
:smiley: `使用<code>mongoose.connect</code>命令来连接数据库。`
143+
:smiley: `使用<code>mongoose.connect</code>命令来连接数据库。`
107144

108145
</details>
109146

@@ -113,18 +150,18 @@
113150
<details><summary>示例（有关测试结果的提示信息）</summary>
114151
原文：`You can return the array with its elements in any order.`
115152

116-
:slightly_frowning_face: `你可以返回一个数组，这个数组中的元素顺序无所谓`
117-
:slightly_frowning_face: `你可以返回一个元素有任意顺序的数组`
118-
:smiley: `返回数组中的元素顺序不会影响测试结果`
153+
:slightly_frowning_face: `你可以返回一个数组，这个数组中的元素顺序无所谓`
154+
:slightly_frowning_face: `你可以返回一个元素有任意顺序的数组`
155+
:smiley: `返回数组中的元素顺序不会影响测试结果`
119156

120157
</details>
121158

122159
<details><summary>示例</summary>
123160
原文：`JavaScript is important, well, you know.`
124161

125-
:slightly_frowning_face: `JavaScript 很重要，那么，你知道的。`
126-
:smiley: `你知道的，JavaScript 很重要。`
127-
:smiley: `JavaScript 很重要，你懂的。`
162+
:slightly_frowning_face: `JavaScript 很重要，那么，你知道的。`
163+
:smiley: `你知道的，JavaScript 很重要。`
164+
:smiley: `JavaScript 很重要，你懂的。`
128165

129166
</details>
130167

@@ -133,41 +170,133 @@
133170
<details><summary>示例</summary>
134171
原文：`Learning JavaScript is fun!`
135172

136-
:slightly_frowning_face: `学 JavaScript 真的太好玩儿了！`
137-
:smiley: `学 JavaScript 很有趣！`
173+
:slightly_frowning_face: `学 JavaScript 真的太好玩儿了！`
174+
:smiley: `学 JavaScript 很有趣！`
138175

139176
</details>
140177

141178
3. 如需保留原文中的英文，请核实拼写是否与官网或 Wikipedia 一致。如 `JavaScript`、`jQuery`、`React`、`MongoDB` 等。
142179

180+
4. 如果你确定原文的表述或格式有误，请不要按照错误的内容翻译，以免造成误导。如果你不确定，可以把内容放到群里跟大家一起讨论。当然，发现错误后，你也最好给原版的 repo 开一个 issue 或 PR。
181+
143182
## 中英有别
144183
1. 英文与中文的句号用法不同。在翻译的时候，有时我们需要把多个句子合并成一句。
145184

146185
<details><summary>示例</summary>
147186
原文：`JavaScript is a high-level, interpreted programming language. It is a language which is also characterized as dynamic and weakly typed.`
148187

149-
:slightly_frowning_face: `JavaScript 是一种高级、解释型的编程语言。它有动态和弱类型的特点。`
150-
:smiley: `JavaScript 是一种动态、弱类型、解释型的高级编程语言。`
188+
:slightly_frowning_face: `JavaScript 是一种高级、解释型的编程语言。它有动态和弱类型的特点。`
189+
:smiley: `JavaScript 是一种动态、弱类型、解释型的高级编程语言。`
151190

152191
</details>
153192

154-
2. 英语中的 `a` 和 `an` 有时候不表示数量，而是泛指。此时不应翻译成“一个”。
193+
2. 英文中的 `a` 和 `an` 有时候不表示数量，而是泛指。此时不应翻译成“一个”。
155194

156195
<details><summary>示例</summary>
157196
原文：`Use CSS to position an element in a flexible way.`
158197

159-
:slightly_frowning_face: `以一种灵活的方式使用 CSS 去布局一个元素。`
160-
:smiley: `灵活地使用 CSS 布局元素。`
198+
:slightly_frowning_face: `以一种灵活的方式使用 CSS 去布局一个元素。`
199+
:smiley: `灵活地使用 CSS 布局元素。`
161200

162201
</details>
163202

164-
3. 英语中习惯使用被动语态，中文则习惯使用主动语态。
203+
3. 英文中习惯使用被动语态，中文则习惯使用主动语态。
165204

166205
<details><summary>示例</summary>
167206
原文：`The direction that child items are arranged is called the main axis.`
168207

169-
:slightly_frowning_face: `子元素排列的方向被称为主轴。`
170-
:smiley: `子元素排列的方向叫做主轴。`
208+
:slightly_frowning_face: `子元素排列的方向被称为主轴。`
209+
:smiley: `子元素排列的方向叫做主轴。`
210+
211+
</details>
212+
213+
4. 英文中经常出现从句（构成复杂句），翻译的时候可以适当地补充主语或宾语。
214+
215+
<details><summary>示例</summary>
216+
原文：`Media Queries are a new technique introduced in CSS3 that change the presentation of content based on different viewport sizes.`
217+
218+
:slightly_frowning_face: `媒体查询是 CSS3 中引入的一项可以根据不同的可视窗口大小来显示不同布局的新技术。`
219+
:smiley: `媒体查询是 CSS3 中引入的一项新技术，它可以根据不同的可视窗口大小来调整页面布局。`
220+
221+
</details>
222+
223+
4. 英文中经常出现从句（构成复杂句），翻译的时候可以适当地补充主语或宾语。
224+
225+
<details><summary>示例</summary>
226+
原文：`Media Queries are a new technique introduced in CSS3 that change the presentation of content based on different viewport sizes.`
227+
228+
:slightly_frowning_face: `媒体查询是 CSS3 中引入的一项可以根据不同的可视窗口大小来显示不同布局的新技术。`
229+
:smiley: `媒体查询是 CSS3 中引入的一项新技术，它可以根据不同的可视窗口大小来调整页面布局。`
230+
231+
</details>
232+
233+
5. 英文中的时态有时不必刻意翻译出来。
234+
235+
<details><summary>示例</summary>
236+
原文：`The lowest number will not always come first.`
237+
238+
:slightly_frowning_face: `最小的数将不会总是出现在数组的第一个元素。`
239+
:smiley: `较小数不一定总是出现在数组的第一个元素。`
240+
241+
</details>
242+
243+
6. 尽量避免双重否定。注意：不一定要出现 `not` 才是否定。
244+
245+
<details><summary>示例</summary>
246+
原文：`There isn't no other way.`
247+
248+
:slightly_frowning_face: `并不是没有其他办法。`
249+
:smiley: `总会有其他办法的。`
250+
251+
</details>
252+
253+
<details><summary>示例</summary>
254+
原文：`Few people would not like to do it.`
255+
256+
:slightly_frowning_face: `一些人会不愿意做这件事。`
257+
:slightly_frowning_face: `很少有人会不愿意做这件事。`
258+
:smiley: `大部分人都愿意做这件事。`
259+
260+
</details>
261+
262+
7. 适当地调整语序，特别是英文中补充说明的部分。
263+
264+
<details><summary>示例</summary>
265+
原文：`HTML and CSS, constructs the web page together with JavaScript.`
266+
267+
:slightly_frowning_face: `HTML 和 CSS，一起构成了页面，与 JavaScript 一起。`
268+
:smiley: `HTML、CSS 与 JavaScript 一同构成页面。`
269+
270+
</details>
271+
272+
8. 英文的分词（participle）有时并不表示时态，尤其是在表示状态的时候。
273+
274+
<details><summary>示例</summary>
275+
原文：`Once done, you may continue to the next challenge.`
276+
277+
:slightly_frowning_face: `当现在的挑战被完成了，你就可以继续做下一个了。`
278+
:smiley: `完成当前的挑战之后，你就可以继续做下一个了。`
279+
280+
</details>
281+
282+
9. 对于多项列举，英文采用逗号分隔，并在最后一个之前加 `and`，或在结尾加 `, etc.`。中文则用顿号分隔，且不要求结尾加“和”。
283+
284+
<details><summary>示例</summary>
285+
原文：`HTML, CSS and JavaScript are fundamental knowledge for web developers.`
286+
287+
:slightly_frowning_face: `HTML，CSS 和 JavaScript 是前端开发的基础。`
288+
:smiley: `HTML、CSS、JavaScript 是前端开发的基础。`
289+
290+
</details>
291+
292+
10. 英文中的同位结构（apposition）一般不必单独翻译，可以合并。注意，同位结构多出现于两逗号之间。但出现在两逗号之间的**不一定是**同位结构，也可以是插入语或复合句的从句。
293+
294+
<details><summary>示例</summary>
295+
原文：`My instructor, John, is a nice guy.`
296+
297+
:slightly_frowning_face: `我的导师，约翰，是个好人。`
298+
:smiley: `我的导师约翰是个好人。`
299+
171300

172301
</details>
173302

0 commit comments

Comments
 (0)