|
| 1 | +## 註解 |
| 2 | + |
| 3 | +此章節將告訴您在程式碼中寫入詳細的文字註解。而在程式碼中的註解文字並不能加以插入文件區塊。為該程式碼下註解的目的就是解釋該段的程式碼的運作跟用途。 |
| 4 | + |
| 5 | +註解能用可人為且易閱讀的方式去述敘該程式碼中複雜的運算,幫助瞭解程式碼之間的運作關係,下註解是值德鼓勵去實行的美德。 |
| 6 | + |
| 7 | +註解盡可能的用一句話解釋完畢,應該是說,它們應該是有完整的思思並可以完全理解的,而不是只有太簡短而帶過。 |
| 8 | + |
| 9 | +註解是不能代替詳細的文檔區塊。它是用來說明代碼本身的羅輯結構,而不是去使用程式碼。 |
| 10 | + |
| 11 | +## 註解的格式 |
| 12 | + |
| 13 | +註解一個區塊的程式碼或是超過兩行者應該使用(c)風格的'/**/',並應與同一空間/標籤規則文檔塊的每一行使用'*'。 如果你需要一個大的引進考慮這個塊是否應被分為一個方法來降低複雜性並因此提供了一個完整的文檔塊。 |
| 14 | + |
| 15 | +註解必需要處於一個優先的地位來解釋程式碼運作的方式。像是要做為一個參考或引用,註解的位置就應該不必跟程式碼置於同一行(與它們放在程式碼的後方做為一個引用)。它們必需跟自己同一行來放置。 |
| 16 | + |
| 17 | +不要在每行的註解跟每行的程式碼之間插入空白行。(在註解的區塊中不要有空白行) |
| 18 | + |
| 19 | +應該是要用一個區塊的方式,也就是說程式碼一個區塊註解一個區塊,然後各個區塊間用一行空白行區隔。 |
| 20 | + |
| 21 | +註解應該跟程式碼的縮排對齊以便優於參考,使用同縮排方式跟隨註解之後。 |
| 22 | + |
| 23 | +註解應該要用(tab)來縮排。(跟程式碼一樣,而不是與文件區塊同排)。 |
| 24 | + |
| 25 | +## 註解的內容表達 |
| 26 | + |
| 27 | +註解的語系必需要是en-GB (請參考下方範例)。 |
| 28 | + |
| 29 | +必需要在//與開頭之間有空隔。 |
| 30 | + |
| 31 | +下一個新行的註解必需大寫以開頭,除非這個新行是延續上一個註解的句子。然而,程式碼是有分大小寫的。 |
| 32 | + |
| 33 | +程式碼所含了特別的相容性去保證其它軟體的正常運作(例如一個特定的瀏覽器或特定的內容管理軟體或需要向下相容往後版本的理由)而必需要特別標明。如果有個不明確的未來或由理要移除這一段程式碼,則讓它處於一個不會去用到的舊程式碼或暫時的去做一個版本的發佈。 |
| 34 | + |
| 35 | +在所有註解中檢查拼字跟語法。(請參考下方範例)。 |
| 36 | + |
| 37 | +只使用一行來完整整個句子。 |
| 38 | + |
| 39 | +而不是使用文件區塊,如果有適合下註解的方式可使用 See:、 Link: 和 Note: 這些標籤。 |
| 40 | + |
| 41 | +除此之外有特別的關係去解釋該內容,則不要使用 HTML 於解註中。 |
| 42 | + |
| 43 | +不要留下註解過的程式碼,除非有明確解釋這樣做的理由,在這樣的情況下,註解說明“程式碼需要被註解”則將不會意外移除。 |
| 44 | + |
| 45 | +註釋可能包括一些程式碼可能在未來會有延展性來修改程式碼,表示了這個程式碼是不完整的或是要用來準備有前瞻性的陳述,也是不一個待辦事項。 |
| 46 | + |
| 47 | +請記住幽默和諷剌是很難翻譯。 |
| 48 | + |
| 49 | +## 縮寫字 |
| 50 | + |
| 51 | +大寫首字母縮寫詞,如HTML,XML,SQL,GMT和UTC的所有字母。這些都是例外,一般使用EN-GB的規則。 |
| 52 | + |
| 53 | +## 常見的拼寫和語法錯誤檢查。 |
| 54 | + |
| 55 | +Joomla的貢獻者包括許多非母語的EN-GB,有時會有拼寫和語法錯誤,這使得它可以理解的。同時,有些人解讀評論也都是非母語,甚至可能使用自動翻譯理解的註釋。這使得它非常重要的意見應遵循正確的EN-GB的拼寫和語法規則。不幸的是,這可能會非常棘手。 |
| 56 | + |
| 57 | +維基百科提供在en-US和en-GB之間很常見的差異做了一個很好的詮釋。http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences 請留意有某些情況下EN-GB的常見用法(而不是實際的規則)略高於EN-AU不相同,使用EN-AU被認為是可以接受的。 |
| 58 | + |
| 59 | +### S 跟 Z 的對決 |
| 60 | + |
| 61 | +EN-GB最常使用``ISE其中的en-US將使用`IZE`,比如`正常化,而不是'正常化'`。 (請注意,有一些例外情況和 en-GB 之間和 en-AU 共同使用一些差別。) |
| 62 | + |
| 63 | +使用單引號是英文的棘手的部分之一。 |
| 64 | + |
| 65 | +### Lets 與 let’s |
| 66 | + |
| 67 | +Lets means permits or allows to: |
| 68 | +讓我們準許這樣做 : |
| 69 | + |
| 70 | +```php |
| 71 | +// This lets the user enter data |
| 72 | +// 這裡讓我們給使用者輸入一些資料 |
| 73 | +``` |
| 74 | + |
| 75 | +Let’s is a contraction for let us and means we are going to do this now: |
| 76 | +讓`我們的縮短為我們和這樣的意思來做: |
| 77 | + |
| 78 | +```php |
| 79 | +// Let's validate the field |
| 80 | +// 讓`我們檢查這個欄位 |
| 81 | +``` |
| 82 | + |
| 83 | +### Its versus it’s |
| 84 | +### 它是 和 它`是 |
| 85 | + |
| 86 | +Its is the possessive form of it: |
| 87 | +它是它的所有格形式 |
| 88 | + |
| 89 | +```php |
| 90 | +// Get its ID |
| 91 | +// 取得它的唉滴,俊郎.... |
| 92 | +``` |
| 93 | + |
| 94 | +It’s is a contraction of it is |
| 95 | +它`是它的一個縮寫 |
| 96 | + |
| 97 | +```php |
| 98 | +// It's time to save |
| 99 | +// 它`是時候去解救了...俊郎郎郎 |
| 100 | +``` |
| 101 | + |
| 102 | +### 在 Joomla 下所拼寫一些常用的單詞。 |
| 103 | + |
| 104 | +- 依賴的 |
| 105 | + |
| 106 | + |
0 commit comments