作者x246libra (宸火)
看板Soft_Job
標題[討論] 註解 用中文還是英文
時間Mon Mar 5 12:37:08 2018
非本科 近了一家小公司 學著寫程式
本身英文不好
英轉中還可以看懂
中轉英常常想不到用什麼詞
勉強靠GOOGLE用些簡單的單字
讓變數或函數 為有意義的命名
但是註解通常要寫的比較詳細
用英文總是思考很久,也不確定文法是否正確
想請問板上的其它人 註解是用中文還是英文寫?
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 61.220.35.157
※ 文章網址: https://webptt.com/m.aspx?n=bbs/Soft_Job/M.1520224631.A.6F4.html
1F：→ ezaki: 以公司的人看得懂和交接方便說明為主 03/05 12:51
2F：→ pttworld: UTF-8的用中文我覺得可以 03/05 12:51
3F：→ robler: 你喜歡就好 03/05 12:52
4F：推 Boston: 英文 03/05 13:05
5F：→ Boston: 就算是 UTF-8 好了，但寫個註解還要切輸入法 不覺得麻煩嗎 03/05 13:05
6F：→ alanturing: 註解是寫給人看的 看的人能快速看懂才是重點 03/05 13:06
7F：→ robber1234: 英文.除非你真的沒法那就中文.中國人超愛寫中文註解 03/05 13:48
8F：→ crossdunk: 我都寫繁體中文，給你參考 03/05 13:50
9F：→ vi000246: 看是要給誰看的 要給外國人看就寫英文 03/05 13:52
10F：→ simonjen: 我們公司有人直接用中文當變數，給你參考！ 03/05 13:57
11F：→ x246libra: 中文當變數 也太誇張XD 03/05 14:03
12F：推 keith222: stackoverflow 上都有人用阿拉伯文變數問問題了 03/05 14:10
13F：→ cphe: 註解就其他人看得懂最重要，文法不用太在意 03/05 14:16
14F：→ cphe: 當然你如果文法錯太誇張讓人看不懂，可以考慮把英文學好 03/05 14:17
15F：→ hizuki: 水平好用英語，期待接手的人看不懂咯 03/05 14:24
16F：推 alihue: 如果都是一些中文專有名詞，中文變數好用啊 03/05 15:12
17F：推 dsilver: 接手的人看不懂，你在公司才有價值(咦) 03/05 16:11
18F：→ PUTOUCHANG: 你可以用英文再加個 text 版的 doc 說明文件 03/05 16:22
19F：→ PUTOUCHANG: 像 Linux kernel 的 Documentation 降 03/05 16:23
20F：推 leolarrel: 推dsilver 03/05 16:31
21F：推 brianhsu: 如果公司的開發者母語都是中文，而且這個程式碼也不需 03/05 16:38
22F：→ brianhsu: 要給第三方，我會寫中文。 03/05 16:39
23F：→ yyc1217: 給誰看就用彼此共通的語言 03/05 16:46
24F：推 johnny94: 編碼沒問題就用中文阿，註解就是要讓人家看懂的。 03/05 17:00
25F：推 sunsamy: 程式碼是最好的註解,若辦不到代表程式水平很差,連命名都 03/05 17:28
26F：→ sunsamy: 有困難,例如某作業系統的/dev/,/tmp/,fs,ls。然後再寫註 03/05 17:28
27F：→ sunsamy: 解：dev is device, tmp is temp, fs is file system 03/05 17:28
28F：→ sunsamy: ls is list。這就是脫褲子放屁了。真的好的註解是連這個 03/05 17:28
29F：→ sunsamy: 區塊,function在做什麼都不用寫,看式碼,名子就略知一二 03/05 17:29
30F：推 peanut97: 公司的人都講中文，所以我都用中文 03/05 17:41
31F：推 coronach: 自從多年前接手中國code被GB碼炸過，我打死都不會寫中文 03/05 18:25
32F：→ coronach: 註解在code裡 03/05 18:25
33F：→ coronach: 如果你的註解用英文寫不出來，那只有兩個可能：1.你要寫 03/05 18:28
34F：→ coronach: 的東西複雜到應該寫在文件裡 2.你的英文程度爛到不該當 03/05 18:28
35F：→ coronach: 工程師 03/05 18:28
36F：→ ku72: 中文習慣就寫中文 03/05 18:40
37F：推 NCUking: 拜託用中文寫就好 英文不好還硬要寫只是浪費隊友時間 03/05 18:59
38F：→ sextitanic: 看你拿到的規格文件跟你同事的共通語言 03/05 19:38
39F：推 stfang925: 只有拿到檔案裡有中文時才會打中文 其他全部英文 03/05 19:42
40F：推 kevin80112: 連變數名稱都要GOOGLE建議用中文 03/05 20:52
41F：→ descent: 我用英文是因為怕亂碼, 其實我想用中文 03/05 21:00
42F：推 winddust: 程式中英文混雜，若是Linux下寫shell，都用英文，主要是 03/05 21:02
43F：→ winddust: 受預設編碼這個變數影響，都要去try charset設定，用英 03/05 21:02
44F：→ winddust: 文省事 03/05 21:02
45F：推 abccbaandy: 中文有時候真的找自己麻煩，尤其環境不能控制的時候 03/05 21:34
46F：推 LinuxKernel: 當然英文啊 03/05 21:45
47F：推 mathrew: 英文 有時候會有編碼問題 03/05 22:21
48F：→ dreamnook: 用拼音寫註解(前同事遇過 03/05 22:44
49F：推 tw689: 你英文好就英文，英文不好就中文 反正大多其實是給自己看的 03/05 22:44
50F：→ clamperni: 中文 03/05 22:56
51F：推 goths5958: 先想清楚註解是為了什麼而寫 就會知道要怎麼選擇 03/06 00:44
52F：→ eva19452002: dirty code才需要註解，clean code只需看variable 03/06 06:28
53F：→ eva19452002: name及function name就知道程式在做什麼了 03/06 06:28
54F：→ eva19452002: 當然還有個前提是每個function內聚力要夠強 03/06 06:31
55F：推 cpper: 說要寫英文的人何不在ptt也寫英文 03/06 07:25
56F：推 Vanses: Definitely English. Unless you want your work can only 03/06 08:21
57F：→ Vanses: be seen, checked and appreciated by Taiwanese and Chi 03/06 08:21
58F：→ Vanses: nese. Say you have a fancy work on Github which has d 03/06 08:21
59F：→ Vanses: escription/inline comment written in Chinese. Only Chi 03/06 08:21
60F：→ Vanses: nese people will understand and appreciate it. You may 03/06 08:21
61F：→ Vanses: try writing the answer in Chinese on stackoverflow an 03/06 08:21
62F：→ Vanses: d see who will give you positive rating. 03/06 08:21
63F：推 nova06091: A pen in my hole 03/06 08:29
64F：推 typepeter: 只限台灣人看的時候也許沒差 但編碼及維護性 英文較好 03/06 08:46
65F：推 nelley: 看交接給誰。。我中英日的都寫過。。。然後，如果你是大 03/06 08:59
66F：→ nelley: 神，你寫台語都會有一堆人搶著看 03/06 08:59
67F：推 RadiationXen: 團隊有人母語不是中文，或不需要把原始碼給第三方 03/06 09:06
68F：→ RadiationXen: 時，可以用中文。話說日本人也會用日文寫註解 03/06 09:06
69F：→ qweqweqweqwe: 有機會交接的人看得懂最重要 語言是拿來溝通的 03/06 09:49
70F：推 vn509942: 英文不好，拜託不要假掰 03/06 10:13
71F：→ vn509942: 註解是寫給人看 不是寫給鬼看 03/06 10:14
72F：推 b086232: 可以參閱我的程式碼會說話，其中有個章節講這個部分。 03/06 12:20
73F：推 akira01: 給台灣與大陸人用繁體中文，給洋人用英文 03/06 13:04
74F：噓 darkMood: 外國你當然就寫英文，台灣當然就寫中文啊，你不知道多少 03/06 13:06
75F：→ darkMood: 工程師英文都爛到爆嘛............................ 03/06 13:06
76F：推 kaitokid1214: 註解就你看得懂,你一個月後看還是看得懂,你一年後看 03/06 13:26
77F：→ kaitokid1214: 還是看得懂,別人N年後拿來問你還是看得懂,這樣就好 03/06 13:26
78F：→ kaitokid1214: 你要用摩斯密碼寫也OK 03/06 13:26
79F：→ NTULioner: 中文通常都額外寫在wiki或文件上吧 03/06 17:54
80F：推 q26766: 不會英文不能當工程師是啥邏輯 03/06 19:35
81F：→ soi1dsnake: 我都用法文 給你參考 03/06 22:24
82F：推 stosto: 註解頂多寫fucking code....那個時候作者就會自己修掉了 03/06 23:34
83F：推 Ghamu: 英文太爛 一句話不知道要有主詞 動詞 時態正確者 乖乖寫中 03/06 23:57
84F：→ Ghamu: 文吧 03/06 23:57
85F：→ Ghamu: 我是偏好寫英文 程式碼是英文 註解也是英文 你的大腦會少一 03/06 23:59
86F：→ Ghamu: 層context switch 拖慢 而英文真的太差者 一般也難寫出可讀 03/06 23:59
87F：→ Ghamu: 的程式碼 03/06 23:59
88F：→ Ghamu: 之前看到有個func 叫做 go() 想說是要go to where? 喔 原來 03/07 00:01
89F：→ Ghamu: 是start()的意思啊 幹你娘 03/07 00:01
90F：推 Ayukawayen: 可能有另一個function叫ready() 03/07 00:12
91F：推 luckyluck: 寫德文 03/07 00:44
92F：推 CHICHINGTSAI: 可能英文比較好喔！避免亂碼搞死後面接手的人還是同 03/07 08:05
93F：→ CHICHINGTSAI: 事 03/07 08:05
94F：推 markbex: 同事和環境都中文就寫中文 要看英文就直接看code就好 03/07 10:37
95F：推 Csongs: 與其讓下面寫些奇怪英文註解 不如用中文 03/07 12:58
96F：→ Csongs: 亂碼問題統一用utf8就好 03/07 12:59
97F：→ Csongs: 上面 go start我笑了XDD 03/07 13:00
98F：→ RumiManiac: go XDDDDDDD 03/07 13:06
99F：→ kenwufederer: 看環境，不需要一定要用英文，讓人頭痛而已 03/07 15:22
100F：推 accessdenied: 不是所有的編譯器都認識UTF8, 用英文比較好。而且 03/07 17:22
101F：→ accessdenied: 用go我覺得也沒什麼問題，很好理解。是閱讀人英文 03/07 17:22
102F：→ accessdenied: 不好，把go和goto搞混。「去！」很直覺啊 03/07 17:22
103F：推 Ghamu: 想想英文或許也不用很好 應該說同一水平就好 都用台式英文 03/08 02:54
104F：→ Ghamu: 也可溝通無障礙 不過我真的十分難理解明明官方api 範例程 03/08 02:54
105F：→ Ghamu: 式碼 setup update put get 等等一堆尋常關鍵字眼不用 偏愛 03/08 02:54
106F：→ Ghamu: 自己造新詞的傢伙在想什麼 我一直盡量想讓東西一致 可依循 03/08 02:54
107F：→ Ghamu: 每次稍微畸形點到命名都在心裡懺悔 [幹...原諒我] 但好像 03/08 02:54
108F：→ Ghamu: 有滿多人是跟著感覺走的 以自己為中心的 03/08 02:54
109F：→ Ghamu: 覺得go 好的 請用go 造一個句子表示啟動一個task. 我用star 03/08 03:07
110F：→ Ghamu: t. start a task 好了那 go呢？ 03/08 03:07
111F：→ PUTOUCHANG: go(); segfault at xxx rip xxx rsp xxx error 6 03/08 03:25
112F：推 dapple: 寫在code裡面的東西都用英文 不要寫中文 03/08 10:00
113F：→ dapple: 之前就遇過注釋寫中文結果build break的事件 03/08 10:01
114F：→ robber1234: 這麼多人贊成不需用英文，看得我心裡發寒 03/08 15:43
115F：→ robber1234: 大學甚至碩士畢業的高材生 英文寫不好還找理由嗎 03/08 15:44
116F：推 hegemon: 全部用英文呀，同事中文不好怎麽辦? 03/08 20:09
117F：推 littleyuan: 我自己是移民北美十幾年在全英環境科技公司工作 如果 03/09 05:40
118F：→ littleyuan: 看到有人寫go也能理解 只是go比較有不同意思 start或 03/09 05:40
119F：→ littleyuan: 許更直觀些 03/09 05:40
120F：推 Csongs: 當你同事英文爛就知道了，review code大陸同仁還用漢語拼 03/09 08:12
121F：→ Csongs: 音參雜，整個昏倒 03/09 08:12
122F：→ johnson0403: 看公司...還有區域 像我們在越南就註解要英越文了... 03/09 19:23
123F：推 lturtsamuel: 看到有人寫個中文就發寒 我也心裡發寒 03/14 16:40
124F：推 bizer: 不是所有compiler都吃中文，但英文是絕對可吃，遇過debug怎 03/26 01:02
125F：→ bizer: 麼找都找不到問題的，結果是註釋不小心打了一個中文字 03/26 01:02