作者wplace (wplace)
看板Soft_Job
標題[請益] 變數命名技巧
時間Sun Jun 14 21:47:49 2020
想請益變數命名有什麼技巧嗎,有時候遇到多個單字在一起的變數或method
都不太會命名,我大部分都打上完整的單字,不過都會變得滿長的
如果想要縮寫,又怕縮寫寫不好到時候別人或者自己回過來看還看不出來
還是縮寫有什麼技巧
還請各位前輩提點
--
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 175.180.122.212 (臺灣)
※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1592142471.A.E10.html
→ Handsomeshen: 省略母音? 06/14 21:50
→ zeroshine: 舉個例子? 06/14 21:53
getFrimwareVersionByXXX (透過XXX取得韌體版本)
→ moom50302: 有些單字其實可以縮寫;駝峰式命名和加底線的方式,都 06/14 22:00
→ moom50302: 可以讓參數比較直觀 06/14 22:00
※ 編輯: wplace (175.180.122.212 臺灣), 06/14/2020 22:07:12
推 cuteSquirrel: getFwVersionByXXX 06/14 22:10
推 donby: GetFwVerByXXX 06/14 22:21
推 Masakiad: 老實說method完全不建議縮寫,除了公認的縮寫有一點機會 06/14 22:25
→ Masakiad: 可以使用外,建議還是寧願過長而不要造成看不懂或跟其他 06/14 22:25
→ Masakiad: 單字的混淆機會 06/14 22:25
→ brianwu1201: 過長沒關係+1,看得懂比較重要。 06/14 22:27
推 Masakiad: 如果推文的舉例,更多時候會像這樣實現:Framework.getV 06/14 22:27
→ Masakiad: ersionByXXXX(...) 06/14 22:27
→ kvjo: 建議分區加底線 如果你駝峰到底 你就知道痛苦... 06/14 22:28
→ kvjo: 通常會很長 都是後面 condition的緣故 前面用途應該是大類 06/14 22:28
→ kvjo: method很長 滿常遇到的 因為條件不同的很多 但用途又類似 06/14 22:29
→ Masakiad: 又或是getInfoByXXXX().framework 06/14 22:29
→ Masakiad: 過長就善用Struct的作法 06/14 22:30
推 Nitricacid: 一堆ByXXX 應該是可以包成 class 的吧 單字縮寫誰 06/14 23:23
→ Nitricacid: 知道你的縮寫是不是其他人的縮寫 06/14 23:23
推 GLaDOS1105: 拜託不要亂縮寫 06/14 23:34
推 tttkkk: 1. 縮寫要有限度 別縮過頭 2. 不要怕變數名稱太長 06/14 23:58
→ tttkkk: 加底線是 Python idiomatic.. 有時你拿底線的變數名稱給 06/14 23:59
→ tttkkk: Java developer 看 他們其實也不習慣 重點是全文要統一 06/15 00:00
→ tttkkk: 使用同一種命名方式 06/15 00:01
推 a8989332: Clean Code: 06/15 00:04
推 bill0205: 不要只縮到只剩頭就好…看了就頭痛 06/15 00:07
→ new122851: 安卓resources只能小寫英文和0-9 06/15 00:46
推 benedict76: method不要縮,method取得好裡面變數縮寫就行,一般人 06/15 01:23
→ benedict76: 應該都看得懂 06/15 01:23
→ Vitaceae: 一個方法60個字元,根本閱讀毒藥 06/15 01:27
→ Vitaceae: 以前罵縮過頭,現在一堆長過頭的 06/15 01:27
→ t64141: 如果XXX是參數可以省略byXXX,但得視情況,不是很通用就 06/15 01:28
推 Ghamu: 我都會上網查一下那個單字的公定縮寫abbreviation 是啥 06/15 02:27
→ Ghamu: 寧可長 不要短看不懂 06/15 02:28
→ Ghamu: 長的被看懂未來還有可被英文好的人refactor 自己沒照英文正 06/15 02:29
→ Ghamu: 確的縮寫亂縮 以後真的只能靠通靈才知道意思了 06/15 02:29
→ Ghamu: 我寫的縮寫有些比較少用的 我還會再後面註解一下縮寫是啥 06/15 02:30
→ Ghamu: 最近回去看半年前自己寫的code 因為有正確命名與註解 3分鐘 06/15 02:31
→ Ghamu: 就找到該找的地方 感到驕傲 06/15 02:31
→ Ghamu: 反觀新公司中國外包的幹你娘程式碼 命名常數int HOST 跟HOS 06/15 02:34
→ Ghamu: T_ 幹你媽兩個值還存不一樣的 真的很想殺人 06/15 02:34
→ Ghamu: 可怕的是我HOST 常數之前已經使用一堆了 冷汗直流 06/15 02:36
→ harry830622: ons 06/15 03:38
→ harry830622: 之前跟同事討論過業界較通用的縮寫 06/15 03:38
→ harry830622: 歡迎大家參考 也歡迎發PR補充XD 06/15 03:38
推 steve1012: 不要縮寫 06/15 04:10
推 wulouise: 如果你有引數,那個by後面的通常可以省略 06/15 06:21
→ Darkword1987: 變數名稱長點會怎樣嗎 06/15 06:59
推 lion741205: 也可以參考一下我的心得 lionethan.com/2019/08/%e7 06/15 07:33
推 azureroki: 對英文不熟悉的看到超長變數很煩躁 06/15 08:11
推 GinginDenSha: 另一個思路是 byXXX 這種程式可以改寫成 Factory M 06/15 08:19
→ GinginDenSha: ethod 或 Strategy 可以省下取名的困擾,又保持程 06/15 08:19
→ GinginDenSha: 式的擴充性 06/15 08:19
推 Csongs: 個人最討厭的就是英文亂縮寫 06/15 09:03
推 vi000246: EbiIwnTuSnpdNfToUiOmf(); 06/15 09:19
推 yyc1217: by(XXX xxx)呢 06/15 10:02
→ yyc1217: 不然原來的例子算OK吧 很好懂呀 06/15 10:03
推 alihue: By 省掉,可以看參數知道。此外應該選可讀性高的字體,長 06/15 10:04
→ alihue: 度不是問題,看不懂命名才是問題 06/15 10:04
推 james732: 我覺得長度沒什麼問題 06/15 10:24
→ james732: 之前看過會縮成GFVBX這種恐怖的縮寫 06/15 10:25
→ x000032001: XXX().Get().Firmware().Version() 06/15 10:37
推 casd82: 看語言吧 像Swift幾乎都不縮寫 cocoa api一堆20-30字母的m 06/15 11:02
→ casd82: ethod Go的話很多api就一堆縮寫 06/15 11:02
推 v7q4: 曾經跟對岸工程師合作 他寫一個method叫getNBvalue() 06/15 11:10
→ v7q4: 我一直不懂什麼NB? 筆電嗎? 還是什麼特殊單字的縮寫?? 06/15 11:11
→ v7q4: 後來問他才知道 NB=牛逼 .... 06/15 11:11
推 cuteSquirrel: XDDDDDDDDDDDDDDDDDD 太牛啦 06/15 11:13
推 alihue: getSBValue() 06/15 11:39
推 wangk13579: 這樣看起來 那位對岸人士也沒什麼問題 取的真牛XDD 06/15 12:05
推 chuegou: getSBvalue 06/15 12:45
推 WTFCN: getNMSLvalue() 06/15 12:57
→ jobintan: 我都打全名,用簡寫的會被誤判。 06/15 13:07
→ jobintan: 例:creditCardInformation()之類的。 06/15 13:11
→ shooter555: 名稱過長會不會是需要在切一層結構的警示呢 06/15 14:14
推 thibw13ug1: 最好是駝峰跟底線兩種一起混用,然後避開password 06/15 16:09
→ thibw13ug1: account login之類的單字,因為弱掃軟體會不管三七二 06/15 16:09
→ thibw13ug1: 十一直接判為弱點 06/15 16:09
推 enthos: fwver@ fwver! /* FORTH get and set */ 06/15 16:24
→ NTULioner: abcdefghihklmn... 06/15 17:45
→ NTULioner: 用完一輪就 aa ab ac ad 06/15 17:46
→ james732: 寫牛逼的我會打死他 XDDD 06/15 17:46
→ roccqqck: 用沒看過縮寫真的很靠北 06/15 18:14
推 askaleroux: getCNMValue(0 06/15 18:14
→ roccqqck: 寫log也不要用縮寫 06/15 18:16
推 wulouise: 我不寫log4都寫2 06/15 18:39
推 jinmin88: 最好 06/15 19:38
推 Ghamu: getNBValue XDDDD 06/16 02:30
→ jobintan: JS我用駝峰,Python用底線,CSS用減號。 06/16 08:07
推 ChungLi5566: 長就給他長啊 縮到看不懂跟aaa bbb有啥差 06/16 08:59
→ jobintan: aaabbb的真的是災難,有時候用日文Romaji與內地的漢語拼 06/16 11:05
→ jobintan: 音搞的命名都好多了。 06/16 11:05
推 ShenJing: 感謝2樓,推影片 06/17 10:27
推 b85040312: 用 aaa bbb 即可,反正 minify 之後也是差不多的 06/20 00:41
推 greenx: 只用大家看得懂的縮寫,不然寧願完整寫清楚 06/20 12:03