作者wplace (wplace)
看板Soft_Job
标题[请益] 变数命名技巧
时间Sun Jun 14 21:47:49 2020
想请益变数命名有什麽技巧吗，有时候遇到多个单字在一起的变数或method
都不太会命名，我大部分都打上完整的单字，不过都会变得满长的
如果想要缩写，又怕缩写写不好到时候别人或者自己回过来看还看不出来
还是缩写有什麽技巧
还请各位前辈提点
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 175.180.122.212 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1592142471.A.E10.html
1F：→ Handsomeshen: 省略母音？ 06/14 21:50
3F：→ zeroshine: 举个例子？ 06/14 21:53
getFrimwareVersionByXXX (透过XXX取得韧体版本)
4F：→ moom50302: 有些单字其实可以缩写；驼峰式命名和加底线的方式，都 06/14 22:00
5F：→ moom50302: 可以让参数比较直观 06/14 22:00
※ 编辑: wplace (175.180.122.212 台湾), 06/14/2020 22:07:12
6F：推 cuteSquirrel: getFwVersionByXXX 06/14 22:10
7F：推 donby: GetFwVerByXXX 06/14 22:21
9F：推 Masakiad: 老实说method完全不建议缩写，除了公认的缩写有一点机会 06/14 22:25
10F：→ Masakiad: 可以使用外，建议还是宁愿过长而不要造成看不懂或跟其他 06/14 22:25
11F：→ Masakiad: 单字的混淆机会 06/14 22:25
12F：→ brianwu1201: 过长没关系+1，看得懂比较重要。 06/14 22:27
13F：推 Masakiad: 如果推文的举例，更多时候会像这样实现：Framework.getV 06/14 22:27
14F：→ Masakiad: ersionByXXXX(...) 06/14 22:27
15F：→ kvjo: 建议分区加底线 如果你驼峰到底 你就知道痛苦... 06/14 22:28
16F：→ kvjo: 通常会很长 都是後面 condition的缘故 前面用途应该是大类 06/14 22:28
17F：→ kvjo: method很长 满常遇到的 因为条件不同的很多 但用途又类似 06/14 22:29
18F：→ Masakiad: 又或是getInfoByXXXX().framework 06/14 22:29
19F：→ Masakiad: 过长就善用Struct的作法 06/14 22:30
20F：推 Nitricacid: 一堆ByXXX 应该是可以包成 class 的吧 单字缩写谁 06/14 23:23
21F：→ Nitricacid: 知道你的缩写是不是其他人的缩写 06/14 23:23
22F：推 GLaDOS1105: 拜托不要乱缩写 06/14 23:34
23F：推 tttkkk: 1. 缩写要有限度 别缩过头 2. 不要怕变数名称太长 06/14 23:58
24F：→ tttkkk: 加底线是 Python idiomatic.. 有时你拿底线的变数名称给 06/14 23:59
25F：→ tttkkk: Java developer 看 他们其实也不习惯 重点是全文要统一 06/15 00:00
26F：→ tttkkk: 使用同一种命名方式 06/15 00:01
27F：推 a8989332: Clean Code: 06/15 00:04
28F：推 bill0205: 不要只缩到只剩头就好…看了就头痛 06/15 00:07
29F：→ new122851: 安卓resources只能小写英文和0-9 06/15 00:46
30F：推 benedict76: method不要缩，method取得好里面变数缩写就行，一般人 06/15 01:23
31F：→ benedict76: 应该都看得懂 06/15 01:23
32F：→ Vitaceae: 一个方法60个字元，根本阅读毒药 06/15 01:27
33F：→ Vitaceae: 以前骂缩过头，现在一堆长过头的 06/15 01:27
34F：→ t64141: 如果XXX是参数可以省略byXXX，但得视情况，不是很通用就 06/15 01:28
35F：推 Ghamu: 我都会上网查一下那个单字的公定缩写abbreviation 是啥 06/15 02:27
36F：→ Ghamu: 宁可长 不要短看不懂 06/15 02:28
37F：→ Ghamu: 长的被看懂未来还有可被英文好的人refactor 自己没照英文正 06/15 02:29
38F：→ Ghamu: 确的缩写乱缩 以後真的只能靠通灵才知道意思了 06/15 02:29
39F：→ Ghamu: 我写的缩写有些比较少用的 我还会再後面注解一下缩写是啥 06/15 02:30
40F：→ Ghamu: 最近回去看半年前自己写的code 因为有正确命名与注解 3分钟 06/15 02:31
41F：→ Ghamu: 就找到该找的地方 感到骄傲 06/15 02:31
42F：→ Ghamu: 反观新公司中国外包的干你娘程式码 命名常数int HOST 跟HOS 06/15 02:34
43F：→ Ghamu: T_ 干你妈两个值还存不一样的 真的很想杀人 06/15 02:34
44F：→ Ghamu: 可怕的是我HOST 常数之前已经使用一堆了 冷汗直流 06/15 02:36
46F：→ harry830622: ons 06/15 03:38
47F：→ harry830622: 之前跟同事讨论过业界较通用的缩写 06/15 03:38
48F：→ harry830622: 欢迎大家参考 也欢迎发PR补充XD 06/15 03:38
49F：推 steve1012: 不要缩写 06/15 04:10
50F：推 wulouise: 如果你有引数，那个by後面的通常可以省略 06/15 06:21
51F：→ Darkword1987: 变数名称长点会怎样吗 06/15 06:59
52F：推 lion741205: 也可以参考一下我的心得 lionethan.com/2019/08/%e7 06/15 07:33
54F：推 azureroki: 对英文不熟悉的看到超长变数很烦躁 06/15 08:11
55F：推 GinginDenSha: 另一个思路是 byXXX 这种程式可以改写成 Factory M 06/15 08:19
56F：→ GinginDenSha: ethod 或 Strategy 可以省下取名的困扰，又保持程 06/15 08:19
57F：→ GinginDenSha: 式的扩充性 06/15 08:19
58F：推 Csongs: 个人最讨厌的就是英文乱缩写 06/15 09:03
59F：推 vi000246: EbiIwnTuSnpdNfToUiOmf(); 06/15 09:19
60F：推 yyc1217: by(XXX xxx)呢 06/15 10:02
61F：→ yyc1217: 不然原来的例子算OK吧 很好懂呀 06/15 10:03
62F：推 alihue: By 省掉，可以看参数知道。此外应该选可读性高的字体，长 06/15 10:04
63F：→ alihue: 度不是问题，看不懂命名才是问题 06/15 10:04
64F：推 james732: 我觉得长度没什麽问题 06/15 10:24
65F：→ james732: 之前看过会缩成GFVBX这种恐怖的缩写 06/15 10:25
66F：→ x000032001: XXX().Get().Firmware().Version() 06/15 10:37
67F：推 casd82: 看语言吧 像Swift几乎都不缩写 cocoa api一堆20-30字母的m 06/15 11:02
68F：→ casd82: ethod Go的话很多api就一堆缩写 06/15 11:02
69F：推 v7q4: 曾经跟对岸工程师合作 他写一个method叫getNBvalue() 06/15 11:10
70F：→ v7q4: 我一直不懂什麽NB? 笔电吗? 还是什麽特殊单字的缩写?? 06/15 11:11
71F：→ v7q4: 後来问他才知道 NB=牛逼 .... 06/15 11:11
72F：推 cuteSquirrel: XDDDDDDDDDDDDDDDDDD 太牛啦 06/15 11:13
73F：推 alihue: getSBValue() 06/15 11:39
74F：推 wangk13579: 这样看起来 那位对岸人士也没什麽问题 取的真牛XDD 06/15 12:05
75F：推 chuegou: getSBvalue 06/15 12:45
76F：推 WTFCN: getNMSLvalue() 06/15 12:57
77F：→ jobintan: 我都打全名，用简写的会被误判。 06/15 13:07
78F：→ jobintan: 例：creditCardInformation()之类的。 06/15 13:11
79F：→ shooter555: 名称过长会不会是需要在切一层结构的警示呢 06/15 14:14
80F：推 thibw13ug1: 最好是驼峰跟底线两种一起混用，然後避开password 06/15 16:09
81F：→ thibw13ug1: account login之类的单字，因为弱扫软体会不管三七二 06/15 16:09
82F：→ thibw13ug1: 十一直接判为弱点 06/15 16:09
83F：推 enthos: fwver@ fwver! /* FORTH get and set */ 06/15 16:24
84F：→ NTULioner: abcdefghihklmn... 06/15 17:45
85F：→ NTULioner: 用完一轮就 aa ab ac ad 06/15 17:46
86F：→ james732: 写牛逼的我会打死他 XDDD 06/15 17:46
87F：→ roccqqck: 用没看过缩写真的很靠北 06/15 18:14
88F：推 askaleroux: getCNMValue(0 06/15 18:14
89F：→ roccqqck: 写log也不要用缩写 06/15 18:16
90F：推 wulouise: 我不写log4都写2 06/15 18:39
91F：推 jinmin88: 最好 06/15 19:38
92F：推 Ghamu: getNBValue XDDDD 06/16 02:30
93F：→ jobintan: JS我用驼峰，Python用底线，CSS用减号。 06/16 08:07
94F：推 ChungLi5566: 长就给他长啊 缩到看不懂跟aaa bbb有啥差 06/16 08:59
95F：→ jobintan: aaabbb的真的是灾难，有时候用日文Romaji与内地的汉语拼 06/16 11:05
96F：→ jobintan: 音搞的命名都好多了。 06/16 11:05
97F：推 ShenJing: 感谢2楼，推影片 06/17 10:27
98F：推 b85040312: 用 aaa bbb 即可，反正 minify 之後也是差不多的 06/20 00:41
99F：推 greenx: 只用大家看得懂的缩写，不然宁愿完整写清楚 06/20 12:03