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