变量名起名缩写的习惯

2017-09-15 13:28:19 +08:00
 Joyreece
算是个日经话题吧,请问前辈们,你们在起变量名的时候会把 View Controller 所写成 VC (例如:resetPasswordVC = xxx )、Text Field 所写成 TF (例如:articleTitleTF = xxx )的这种形式么?

我纠结的在于想保持代码的可读性和简洁干净,但是在实例化一些类的时候起名有的时候犹豫不决是写成 VC 这种缩写还是写全了。参考过原声 SDK 一些头文件露出来的方法,看苹果也是有的直接写成 viewController 也有是 vc。

所以想看看哪种风格更好一些呢?
10689 次点击
所在节点    iDev
37 条回复
geelaw
2017-09-15 19:20:24 +08:00
@fy
@newtype0092

ret = return (value)
fy
2017-09-15 19:28:05 +08:00
@AngelCriss
@geelaw

哦对啊 ret 是 return。

不过这个变量使用场景和 result 基本相同就是了。
kx5d62Jn1J9MjoXP
2017-09-15 19:33:44 +08:00
我越是局部的代码越用缩写,类的成员变量用完整的单词
alexgor
2017-09-15 19:35:00 +08:00
额……驼峰啊
ExploreWay
2017-09-15 19:37:24 +08:00
我觉得大家说的很好,这个变量命名一定要讲究可读性。上面提到的一些约定熟成的东西,是可以写缩写的,当然你也可以选择全写。(注:本人平时也没有注意这个问题,缩写的比较严重,今后也要多注意这个问题)
carlclone
2017-09-15 20:27:34 +08:00
什么年代了还缩写,自动完成一个 tab 的事情,以前没有还能理解
Sapp
2017-09-15 21:50:38 +08:00
如果大家都理解,就缩写,比如 xxxBtn、el、msg、req、res 否则还是写全。
dsg001
2017-09-15 22:04:56 +08:00
遵循一个原则,变量范围越大变量名越长
mcfog
2017-09-15 22:20:46 +08:00
一个是看 scope,另一个是看是否 ambiguous,比如 ret res 这种坚决不缩写

result response resource return 傻傻分不清楚
gamexg
2017-09-16 08:49:42 +08:00
跟 go 标准库学的,短函数内部变量敢用单字母变量名。
对外的就继续长变量名。
beimenjun
2017-09-16 12:32:10 +08:00
既然你发在 iDev 节点里,个人认为,ViewController 缩写成 VC,在 iOS 这个部分是一种很常见的写法,至于你说的 TF,就太偏了。

既然常见到可以约定俗成的,又不是啥洪水猛兽,为啥不选择缩写呢?
Meli55a
2017-09-16 13:48:05 +08:00
@flyingghost @ssynhtn @beimenjun 认同,我很推崇规范的东西,看着舒服,很不喜欢取名随意的代码,看着难受,已经都有点偏激了
newtype0092
2017-09-18 23:25:05 +08:00
@AngelCriss 我是做客户端的,很多模版工程里都有 src(source)和 res(resource),从没有见过 rsc,这个和 src 放在一起一看就懵逼了吧。。。ret 确实也可以看作 return,不过 return 和 result 其实没啥区别,return 的当然就是 result 了~
shawndev
2017-09-28 09:02:41 +08:00
除非类名会长到 xcode 左侧文件导航栏折叠内容否则不缩写,变量名不缩写,可以看一下代码整洁之道。
iwpz
2017-10-13 14:10:15 +08:00
ProfileViewController *pvc = [[ProfileViewController alloc] init];
[nav pushvc:pvc];

对 vc 的调用不就只有 push pop 那么几行吗,挨着很近,都能看见。
所以我是这么写的。

ShopViewController *svc
MainViewController *mvc
Obelly
2017-10-19 18:11:03 +08:00
短函数内(<20 行),爱怎么来怎么来,ijklnm 单字母都没人管,暴露接口,怎么长怎么来……
话说一定要把类型带到命名里面么?
syrupofplum
2020-05-09 11:35:59 +08:00
ret 做 result 缩写使用的时候,感觉很容易和 return 混淆。
所以我一直把 result 缩写成 rst 。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/390931

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX