码迷,mamicode.com
首页 > 其他好文 > 详细

计算机科学只存在两个难题:缓存失效和命名

时间:2016-05-02 23:04:47      阅读:1078      评论:0      收藏:0      [点我收藏+]

标签:

“计算机科学只存在两个难题:缓存失效和命名。” ——Phil KarIton

前言

命名一直是我编程过程中很头痛的事,有时为了一个恰当的名称是想了又想,还忍不住Google一下。命名真是一门艺术,好的命名那叫一个高大上。今天总结一些前端命名的规范,梳理一份自己的命名想法,从以下4种代码风格的命名规范部分获取灵感:

1. Google JavaScript代码风格指南

2. Crockford代码规范

3. Dojo Javascript 编程规范

4. jQuery核心风格指南

PS:未列出来的,代表没对此种命名做规范。

JavaScript

1. 变量

Google JavaScript代码风格指南 小驼峰命名规则
Dojo Javascript 编程规范 小驼峰命名规则
jQuery核心风格指南 小驼峰命名规则

这里有一点要澄清的事,网上很多Dojo Javascript 编程规范的资料说”变量名称必须为小写字母“,我半天不敢相信,直接找上Dojo官网文档,里面根本就没这么说,而是说是混合大小写(就是小驼峰)。

——所以结论是,变量用”小驼峰命名规则“。

2. 常量

Google JavaScript代码风格指南 大写字母,单词间加下划线,例:var SECONDS_IN_A_MINUTE = 60;
Dojo Javascript 编程规范 大写字母,单词间加下划线 或 大驼峰命名规则

好吧,其实Dojo Javascript 编程规范根本没说”大写字母,单词间加下划线“,只是说了大写字母,我看得不顺眼加的,我就喜欢这种。

——所以结论是,常量用”大写字母,单词间加下划线“。

3. 函数

Google JavaScript代码风格指南 小驼峰命名规则,例:functionNamesLikeThis
Dojo Javascript 编程规范 小驼峰命名规则,必须为动词或者是动词短语。例:obj.getSomeValue()
jQuery核心风格指南 小驼峰命名规则

这一次我非常赞同Dojo Javascript 编程规范命名方式,就必须要是动词或者是动词短语。函数也是方法,叫法不同而已。

——所以结论是,函数名用”小驼峰命名规则,必须为动词或者是动词短语“。

4. 类

Google JavaScript代码风格指南 大驼峰命名规则,例:ClassNamesLikeThis
Dojo Javascript 编程规范 大驼峰命名规则

JavaScript本身没有类这种东西,只不过是模拟出来的,本质还是个函数。不过命名的确是要不同, 另外构造函数命名跟类相同。

——所以结论是,类名用”大驼峰命名规则“。

5. 枚举变量

Google JavaScript代码风格指南 大驼峰命名规则,例:EnumNamesLikeThis
Dojo Javascript 编程规范 大驼峰命名规则

这个没什么争议。

——所以结论是,类名用”大驼峰命名规则“。

CSS

CSS的编写有几个准则:

1. 短ID或类命名,但确保他们不要太过隐晦,或直白(如#blue-button)。

2. 大型项目使用前缀,如#xyz-help, .xyz-column(分模块)。

3. 单词直接间隔使用”-“(NEC规范文档里面就是用”-“)。

    即使是不用,使用其他驼峰式或下划线,那就必须统一风格,别一会用这用那。

自问自答

1. CSS,class或id的单词间隔是使用横杠或者下划线或驼峰式?

我觉得当中选择了一种,那么整个风格就统一成那种, 不要像风像云又像雨,什么都用。我建议是用横杠,看起来舒服一些。

2. 文件名要不要驼峰式,首字母要大写吗?

首先文件名必须简明扼要,别又臭又长。有很多方式:

1. 全部小写,单词间用下划线。例: photo_gallery.js

2. 全部小写,单词间用横杠。例: photo-gallery.js

3. 全部小写,单词间不使用任何字符分割。例: photogallery.js

4. 小驼峰式。例: photoGallery.js

这个我真没有确定要用哪一种,哪一种是最靠谱的,但应该是没有以大写字母开头的。

3. 私有变量、函数要用下划线前缀吗?

Dojo Javascript 编程规范 是规定必须要下划线前缀的,其他规范并没有要求。而我觉得使用下划线前缀是比较好的,它很大的优点是很明确区分了公共变量和私有变量,一目了然(还有一点淡淡的逼格)。

 

总结

Crockford代码规范并没有对命名规范的说明,兴许是我没找到。相反的,Dojo Javascript 编程规范对于命名规范这部分着实详尽,里面很多可借鉴地方,我取了一点东西。还有HTML的本身就不建议使用自定义标签,所以也没什么命名问题,至于属性,统一风格就行了。

我在文章里面最常说的是统一风格,现实团队协作时候,开始能先统一下规范,对整体代码风格非常有好处的,自己看起来也舒服。最后命名需慎重,尽量简明扼要、清晰易懂。

 

参考文献

1. 《翻译:谷歌HTML、CSS和JavaScript风格规范》 by 张鑫旭

2. 《Google JavaScript代码风格指南

3. 《Crockford 编程规范》 by 阮一峰

4. 《规范自己的JavaScript书写 – Dojo Javascript 编程规范》by 彬Go

 

本文为原创文章,转载请保留原出处,方便溯源,如有错误地方,谢谢指正。

本文地址 :http://www.cnblogs.com/lovesong/p/5423425.html

 
分类: javascript

计算机科学只存在两个难题:缓存失效和命名

标签:

原文地址:http://www.cnblogs.com/Leo_wl/p/5453282.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!