变量的命名规则有什么比较规范且美观的吗?

2020-12-26 18:00:50 +08:00
 wszgrcy

最近在纠结这么一个问题,如果一个变量是数组,那么应该命名为 xxxArray,xxxList,xxxs 还是什么其他的,感觉好像从叫法上都说得通,但是不知道有没有什么具体的说道比如某种命名规范?

还有文件夹命名,那种比较通用的方法,应该起一个什么文件夹名,core,common,util,helper....以及文件夹名应不应该加 s......

5321 次点击
所在节点    程序员
36 条回复
debuggerx
2020-12-26 19:10:41 +08:00
个人觉得能思考这个问题的就已经是难能可贵的好同志了,统一的规范可能不会有,只要能“讲得通”让大多数人理解就很好了……然后就是开启 IDE 的拼写检查,或者装个拼写检查插件,别写拼错的单词和无意义的变量名,就胜过 90%的同行了
favourstreet
2020-12-26 19:41:29 +08:00
当不确定别人能不能看懂时,把变量名喂给英翻中软件,如果翻出来的中文看起来还可以,变量名就算不错的了
renmu123
2020-12-26 19:45:19 +08:00
看你语言习惯,我觉得都 ok,如果命名成 xxxs,还要想是 xxxes,还有不可数,太麻烦了
eason1874
2020-12-26 19:57:26 +08:00
用 xxxs 多吧,重点在于不用意义不明的缩写,格式统一。

可以学下匈牙利命名法,直接在开头用小写字母表明类型。比如用 s 表示字符串,用 a 表示数组。
jerryrib
2020-12-26 20:06:37 +08:00
zachlhb
2020-12-26 20:11:44 +08:00
我觉得命名还是要看语言和框架,尽量使用语言和框架的命名规范比较好,这样看着统一,至于变量命名其实都可以,重点是一个项目中从头到尾最好使用一种命名格式
PeterChu9527
2020-12-26 21:21:18 +08:00
阿里的《 Java 开发手册》值得参考。
gwybiaim
2020-12-26 21:27:13 +08:00
@favourstreet #2 所以为什么不直接用合适的母语词汇进行命名?
abersheeran
2020-12-26 21:37:58 +08:00
只要够统一,你可以用拼音、用汉字、用日语、用西班牙语都可以。代码规范的重点不在于单个命名是否信达雅,而在于整个项目的命名是否遵循同一种规则,减少阅读时的心智负担。
youla
2020-12-26 21:41:49 +08:00
我因为变量名命名被警告了,老大:你能不能别在变量名上加上自己的名字啊?
youla
2020-12-26 21:42:14 +08:00
准确来说还有文件名…
elintwenty
2020-12-26 21:43:29 +08:00
简单一点,看《代码整洁之道》,里面有关于命名的章节;
实际一点,如果是 Java,直接看阿里的手册和常见框架的源码,直接看命名风格就行;
有效一点,和身边其他人保持一致;
根本一点,从其他人的角度出发,想一想另一个人能不能看懂你命名的意图就好。
freebird1994
2020-12-26 21:54:24 +08:00
可以看看框架源码。命名风格很值得借鉴
Rache1
2020-12-26 22:05:19 +08:00
代码里面见到过一种,一个产品 ID 的数组,然后看到了 ProductIds 的命名 ,个人比较能接受 ProductsId 的形式。

就是 xxxsId 和 xxxIds 的区别。
raaaaaar
2020-12-26 23:00:28 +08:00
@youla #10 为什么要这么干 ←_←
forgottencoast
2020-12-26 23:34:24 +08:00
.Net 有, 《 NET 设计规范:约定、惯用法与模式(第 2 版)》
AllenHua
2020-12-27 00:33:32 +08:00
javaer 推崇 阿 li 规范 可阅读性很高 是 map 变量后加 map (比如 userNameMap ) 是 list 就加 list (比如 resultList ) 但是这种代码的确又臭又长 :狗头)
iyeatse
2020-12-27 01:34:47 +08:00
说到可数和不可数,就想到项目代码里遍地的 datas 了。。。简直是跟阀值和请稍后一样令人拳头发硬的存在
HY3
2020-12-27 03:30:45 +08:00
个人感觉还是要考虑一下单复数和不可数名词的。比如楼上说的 data 。还有比如 matrices 这种。还有一个令人“拳头发硬的”是 codes 。
kaiki
2020-12-27 05:31:00 +08:00
试试用拼音,可以气死看你代码的人
我反正不敢这么干

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

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

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

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

© 2021 V2EX