Add Inline comment #18
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
俊朗朗朗朗 ... lol |
|
|
||
| Comments that are written in a readable and narrative style, especially when explaining a complex process, are encouraged. In general they should be placed close to the code explained rather than before the entire block of code. | ||
| 註解能用可人為且易閱讀的方式去述敘該程式碼中複雜的運算，幫助瞭解程式碼之間的運作關係，下註解是值德鼓勵去實行的美德。 |
There was a problem hiding this comment.
可以這樣改看看
我們鼓勵註解用易於閱讀和敘事的風格撰寫，尤其是在解釋一個複雜流程的時候。一般來說註解應該置於要被解釋的程式碼附近，而非在一整個程式區塊前面。
|
|
||
| en-GB most commonly uses `ise` where en-US would use `ize`, such as `normalise` instead of `normalize`. (Note that there are some exceptions to this rule and some differences between en-GB and en-AU in common usage.) | ||
| EN-GB最常使用 `ise` ，而 en-US 較常使用 `ize` ，比如應使用 `normalise` 而不是 `normalize`。 （請注意，有一些例外情況和，且 en-GB 和 en-AU 之間的常見用法又有一些差別。） |
|
話說 |
|
|
||
| Comments are not a replacement for detailed doc blocks. Comments serve to explain the logic and structure of code itself rather than the use of code. | ||
| 註解是不能代替詳細的文檔區塊。它是用來說明代碼本身的羅輯結構，而不是去使用程式碼。 |
|
大概先修到這邊吧...其他應該沒什麼大問題 |
|
@michael520 幫我修改可以嗎 |
|
oh ~ yes |
|
已在 PR #19 另外修正了。 |
|
步驟有錯，關掉 PR #19 |
|
@LeoOnTheEarth 看沒問題就 merge 吧 |
|
|
||
| Comments are not a replacement for detailed doc blocks. Comments serve to explain the logic and structure of code itself rather than the use of code. | ||
| 註解是不能代替詳細的區塊註解。它是用來說明代碼本身的羅輯與結構，而不是去使用程式碼。 |
There was a problem hiding this comment.
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
這是從去年 @michael520 的翻譯版本修正過來的（一堆 Google 翻譯.....）（還有一堆「俊朗」）
麻煩 @LeoOnTheEarth @bblurock 幫忙 review
看
manual/zh-TW/coding-standards/chapters/inline-comments.md這個檔案即可，_old內的之後要移除