[請益] 變數命名技巧
想請益變數命名有什麼技巧嗎,有時候遇到多個單字在一起的變數或method
都不太會命名,我大部分都打上完整的單字,不過都會變得滿長的
如果想要縮寫,又怕縮寫寫不好到時候別人或者自己回過來看還看不出來
還是縮寫有什麼技巧
還請各位前輩提點
--
省略母音?
舉個例子?
getFrimwareVersionByXXX (透過XXX取得韌體版本)
有些單字其實可以縮寫;駝峰式命名和加底線的方式,都
可以讓參數比較直觀
getFwVersionByXXX
GetFwVerByXXX
聞香一下 以前26同事取的 https://i.imgur.com/QdO4bqq.png
老實說method完全不建議縮寫,除了公認的縮寫有一點機會
可以使用外,建議還是寧願過長而不要造成看不懂或跟其他
單字的混淆機會
過長沒關係+1,看得懂比較重要。
如果推文的舉例,更多時候會像這樣實現:Framework.getV
ersionByXXXX(...)
建議分區加底線 如果你駝峰到底 你就知道痛苦...
通常會很長 都是後面 condition的緣故 前面用途應該是大類
method很長 滿常遇到的 因為條件不同的很多 但用途又類似
又或是getInfoByXXXX().framework
過長就善用Struct的作法
一堆ByXXX 應該是可以包成 class 的吧 單字縮寫誰
知道你的縮寫是不是其他人的縮寫
拜託不要亂縮寫
1. 縮寫要有限度 別縮過頭 2. 不要怕變數名稱太長
加底線是 Python idiomatic.. 有時你拿底線的變數名稱給
Java developer 看 他們其實也不習慣 重點是全文要統一
使用同一種命名方式
Clean Code:
不要只縮到只剩頭就好…看了就頭痛
安卓resources只能小寫英文和0-9
method不要縮,method取得好裡面變數縮寫就行,一般人
應該都看得懂
一個方法60個字元,根本閱讀毒藥
以前罵縮過頭,現在一堆長過頭的
如果XXX是參數可以省略byXXX,但得視情況,不是很通用就
我都會上網查一下那個單字的公定縮寫abbreviation 是啥
寧可長 不要短看不懂
長的被看懂未來還有可被英文好的人refactor 自己沒照英文正
確的縮寫亂縮 以後真的只能靠通靈才知道意思了
我寫的縮寫有些比較少用的 我還會再後面註解一下縮寫是啥
最近回去看半年前自己寫的code 因為有正確命名與註解 3分鐘
就找到該找的地方 感到驕傲
反觀新公司中國外包的幹你娘程式碼 命名常數int HOST 跟HOS
T_ 幹你媽兩個值還存不一樣的 真的很想殺人
可怕的是我HOST 常數之前已經使用一堆了 冷汗直流
ons
之前跟同事討論過業界較通用的縮寫
歡迎大家參考 也歡迎發PR補充XD
不要縮寫
如果你有引數,那個by後面的通常可以省略
變數名稱長點會怎樣嗎
也可以參考一下我的心得 lionethan.com/2019/08/%e7
對英文不熟悉的看到超長變數很煩躁
另一個思路是 byXXX 這種程式可以改寫成 Factory M
ethod 或 Strategy 可以省下取名的困擾,又保持程
式的擴充性
個人最討厭的就是英文亂縮寫
EbiIwnTuSnpdNfToUiOmf();
by(XXX xxx)呢
不然原來的例子算OK吧 很好懂呀
By 省掉,可以看參數知道。此外應該選可讀性高的字體,長
度不是問題,看不懂命名才是問題
我覺得長度沒什麼問題
之前看過會縮成GFVBX這種恐怖的縮寫
XXX().Get().Firmware().Version()
看語言吧 像Swift幾乎都不縮寫 cocoa api一堆20-30字母的m
ethod Go的話很多api就一堆縮寫
曾經跟對岸工程師合作 他寫一個method叫getNBvalue()
我一直不懂什麼NB? 筆電嗎? 還是什麼特殊單字的縮寫??
後來問他才知道 NB=牛逼 ....
XDDDDDDDDDDDDDDDDDD 太牛啦
getSBValue()
這樣看起來 那位對岸人士也沒什麼問題 取的真牛XDD
getSBvalue
getNMSLvalue()
我都打全名,用簡寫的會被誤判。
例:creditCardInformation()之類的。
名稱過長會不會是需要在切一層結構的警示呢
最好是駝峰跟底線兩種一起混用,然後避開password
account login之類的單字,因為弱掃軟體會不管三七二
十一直接判為弱點
fwver@ fwver! /* FORTH get and set */
abcdefghihklmn...
用完一輪就 aa ab ac ad
寫牛逼的我會打死他 XDDD
用沒看過縮寫真的很靠北
getCNMValue(0
寫log也不要用縮寫
我不寫log4都寫2
最好
getNBValue XDDDD
JS我用駝峰,Python用底線,CSS用減號。
長就給他長啊 縮到看不懂跟aaa bbb有啥差
aaabbb的真的是災難,有時候用日文Romaji與內地的漢語拼
音搞的命名都好多了。
感謝2樓,推影片
用 aaa bbb 即可,反正 minify 之後也是差不多的
只用大家看得懂的縮寫,不然寧願完整寫清楚
55
[心得][英文] 如何命名「次數」變數之前談過「數量」(參考 ),這次我想談談「次數」, 以及回答幾個讀者問題。 * 如何命名「次數」變數? * 「次數」與「數量」有什麼不一樣? * 可以用 times 嗎?48
[問卦] 寫程式要怎麼命名?安安 小弟程式社畜拉 小弟我從小就有命名困難症 玩網遊第一天就是在取名中度過得 最近PTT開放註冊我也因為想不出新唉低所以沒去註冊49
[心得][英文] 如何命名「數量變數」「英文」是不少人學寫程式的一個關卡,而「命名」又是電腦科學最難的問題之一 。我正在整理幾個最常見的「如何用英文命名程式裡的某個東西?」的問題與答案 ,在此與各位分享目前整理好的第一個題目: * 如何命名「數量變數」? * Count / Number / Quantity29
[問卦] 姓隋孩子怎麼命名?阿肥開始寫程式後才發現 命名是門學問啊,還很深 寫程式花最長的時間就是思考如何命名變數 扯遠了 隋棠的孩子好像不姓隋,沒有從母姓19
[心得][英文] 刷 LeetCode 練習命名# 刷 LeetCode 練習命名 過去幾個月,《程式英文》把焦點放在「分享知識」;例如,變數名稱樣板、單字 使用情景、等等。對學習者來可說是「輸入」的動作。 這次試個不同的方向,做了個實驗,把焦點換到「演練技巧」,希望能幫助學習者 改善輸入與輸出的平衡。16
[請益] 欄位或是變數改名這邊想請問各位前輩系統維護上常常遇到的一個問題 就是程式中的變數或是資料表欄位命名的"變更" 我不確定是不是一開始我的設計的想法就錯了 通常我在設計時,會將使用者的操作"畫面"與系統中的命名盡量保持一致, 討論起來比較有共通的語言,尤其是在一些專有名詞的欄位命名上。12
[心得][英文] 如何命名「集合名詞」數量變數?本週主題 * 如何命名「集合名詞」數量變數? * 「集合名詞」「整體」數量變數 * 「集合名詞」「成員個體」數量變數 * 如何命名「回傳值」?6
[問卦] 為什麼沒有人抱怨蘋果英文鍵盤不好用啊Rt 我要來抱怨蘋果的英文鍵盤啦 常常打一些像ptt 還是其他非英文單字的 英文縮寫時 鍵盤常常幫我自動選字2
[心得][英文] 高中6K字-108版# 高中6K字-108版 大學入學考試中心「選才電子報」第 312 期( 2020-08-17 )談論了新版的 《高中英文參考詞彙表》,內有單字、詞性、級別,並提供 PDF 版下載;我把它 清理了一下,整理出 JSON 版及 Google Sheets 版,方便應用。 * Google Sheets 版: