1
1
## 行內註解
2
2
3
- 此章節將告訴您在程式碼中寫入詳細的文字註解。而在程式碼中的註解文字並不能加以插入文件區塊。為該程式碼下註解的目的就是解釋該段的程式碼的運作跟用途 。
3
+ 此章節涵蓋更詳細的行內註解方式。行內註解指的是那些除了註解區塊之外的註解。行內註解的目的是以有脈絡的方式來解釋程式內容,這樣的解釋內容可能有各種不同的形式 。
4
4
5
5
我們鼓勵註解用易於閱讀和敘事的風格撰寫,尤其是在解釋一個複雜流程的時候。一般來說註解應該置於要被解釋的程式碼附近,而非在一整個程式區塊前面。
6
6
7
7
註解盡可能的用一句話解釋完畢,應該是說,它們應該是有完整的思思並可以完全理解的,而不是只有太簡短而帶過。
8
8
9
9
註解是不能代替詳細的文檔區塊。它是用來說明代碼本身的羅輯結構,而不是去使用程式碼。
10
10
11
- ## 註解的格式
11
+ ## 註解格式
12
12
13
- 註解一個區塊的程式碼或是超過兩行者應該使用(c)風格的'/ ** /',並應與同一空間/標籤規則文檔塊的每一行使用' * '。 如果你需要一個大的引進考慮這個塊是否應被分為一個方法來降低複雜性並因此提供了一個完整的區塊註解 。
13
+ 註解區塊要講解一個大程式區塊而且有超過兩行以上的註解時,需要使用 ` /* */ ` 的註解方式,而且每一行使用 ` * ` 以及與區塊註解一樣的空白 / tab 鍵規則。如果你需要大篇福的講解,可以考慮將該程式區塊拆解成一個 method 來降低複雜度,更可因此提供一個完整的區塊註解 。
14
14
15
- 註解必需要處於一個優先的地位來解釋程式碼運作的方式。像是要做為一個參考或引用,註解的位置就應該不必跟程式碼置於同一行(與它們放在程式碼的後方做為一個引用)。它們必需跟自己同一行來放置 。
15
+ 註解必需放在相關程式碼之前,依此推論,註解不該與相關程式碼放在同一行上 (把註解放在程式碼之後),它們需各自在自己的行數上 。
16
16
17
- 不要在每行的註解跟每行的程式碼之間插入空白行。(在註解的區塊中不要有空白行 )
17
+ 不要在註解與相關的程式碼之間留下空行。(沒有空白字元在註解的下面 )
18
18
19
- 單行註解與多行註解之上永遠都要有一個空行 ,除非他們在一個程式區塊的開頭。(因為你不該在 ` } ` 之後出現空行)
19
+ 單行註解與多行註解之前都要有一個空行 ,除非他們在一個程式區塊的開頭。(你不該在 ` } ` 之後出現空行)
20
20
21
- 例如這段程式,第一段註解之前沒有空行(因為在 ` { ` 之後),但第二段註解前我們就會希望要空一行 。
21
+ 例如這段程式,第一段註解之前沒有空行(因為在 ` { ` 之後),但第二段註解前我們是真的需要換行 。
22
22
23
- ``` php
23
+ ``` php
24
24
while (!$done)
25
25
{
26
26
// We don't want an infinite loop here.
@@ -35,21 +35,21 @@ $result = somethingInteresting();
35
35
36
36
註解應該要用(tab)來縮排。(跟程式碼一樣,而不是與區塊註解一樣)。
37
37
38
- ## 註解的內容表達
38
+ ### 註解內文
39
39
40
40
註解的語系必需要是en-GB (請參考下方範例)。
41
41
42
- 必需要在 ` // ` 與開頭之間有空隔 。
42
+ 在 ` // ` 與註解文字之間一定要有一個空白 。
43
43
44
- 下一個新行的註解必需大寫以開頭,除非這個新行是延續上一個註解的句子。當那段註解是程式碼且是大小寫敏感的時候則例外 。
44
+ 每行註解需要以大寫字母開頭,除非該行是接續著一個完整的句子,或是文字為程式碼而且是需要注意大小寫的 。
45
45
46
- 程式碼中包含了特別的部份去確保與其他軟體的相容性時(例如為了相容瀏覽器或 CMS 的舊版時),應該要刻意且清楚的描述它。如果有打算在未來的某時間點刪除這段程式碼 ,請標註它但不要使用棄用 (deprecation) 標籤或標註特定版本。
46
+ 某段程式碼為確保與其他軟體的相容性時(例如為了相容瀏覽器或特定版本的 CMS 時),應該要清楚地描述它。如果預計在未來的某時間點刪除某段程式碼 ,請標註它但不要使用棄用 (deprecation) 標籤或標註特定版本 (版本較難以預知) 。
47
47
48
48
在所有註解中檢查拼字跟語法。(請參考下方範例)。
49
49
50
- 只使用一行來完整整個句子 。
50
+ 只在完整的句子使用句點做結尾 。
51
51
52
- See:、 link : 和 note: 這些標籤盡量用在區塊註解中而非一般註解 。
52
+ 與其使用區塊註解的標籤,適當地在註解中使用 See:、Link : 和 Note: 。
53
53
54
54
除非有特別的需求,否則不要在註解中使用 HTML。
55
55
@@ -59,21 +59,21 @@ See:、 link: 和 note: 這些標籤盡量用在區塊註解中而非一般註
59
59
60
60
請記住幽默和諷剌是很難翻譯。
61
61
62
- ## 縮寫字
62
+ ### 縮寫字
63
63
64
- 大寫首字母縮寫詞,如HTML ,XML,SQL,GMT和UTC的所有字母。這些都是例外,一般使用EN-GB的規則 。
64
+ 縮寫字所有的字母都要大寫,像是 HTML ,XML,SQL,GMT 和 UTC 等。而像 en-GB 的規則是一種例外 。
65
65
66
- ## 常見的拼寫和語法錯誤檢查。
66
+ ### 常見的拼寫和語法錯誤檢查。
67
67
68
- Joomla的貢獻者包括許多並非以 en-GB 為母語的人,有時會有拼寫和語法錯誤,這是可以理解的。 同時,有些人也是以非母語的概念去解讀註解內容,甚至可能使用自動翻譯去理解這些註解 。因此遵循正確的 en-GB 的拼寫和語法規則是非常重要的。不幸的是,這可能會有點困難。
68
+ Joomla的貢獻者包括許多並非以 en-GB 為母語的人,有時會有拼寫和語法錯誤,這是可以理解的。 同時,有些人也是以非母語的概念去解讀註解內容,甚至可能使用翻譯機去理解這些註解 。因此遵循正確的 en-GB 的拼寫和語法規則是非常重要的。不幸的是,這可能會有點困難。
69
69
70
70
維基百科在 [ en-US 與 en-GB 之間常見的不同點] ( http://www.wikiwand.com/en/American_and_British_English_spelling_differences ) 這篇文章中提供了不錯的說明。請留意有某些情況下 en-GB 的常見用法(而不是實際的規則)與 en-AU 略有不同,此時使用 en-AU 是可以接受的。
71
71
72
72
### S 與 Z
73
73
74
- EN-GB最常使用 ` ise ` ,而 en-US 較常使用 ` ize ` ,比如應使用 ` normalise ` 而不是 ` normalize ` 。 (請注意,有一些例外情況和,且 en-GB 和 en-AU 之間的常見用法又有一些差別。)
74
+ EN-GB最常使用 ` ise ` ,而 en-US 較常使用 ` ize ` ,比如應使用 ` normalise ` 而不是 ` normalize ` 。 (請注意,有一些例外情況而且 en-GB 和 en-AU 之間的常見用法又有一些差別。)
75
75
76
- 使用單引號是英文的棘手的部分之一 。
76
+ 使用單引號是英文較棘手的部分之一 。
77
77
78
78
### Lets 與 let’s
79
79
@@ -103,7 +103,7 @@ It’s 是 it is 的縮寫
103
103
// It's time to save
104
104
```
105
105
106
- ### 在 Joomla 下所拼寫一些常用的單詞 。
106
+ ### 在 Joomla 中常用單詞的正確寫法 。
107
107
108
108
- dependant (依賴)
109
109
- deprecated (被棄用的)
0 commit comments