posts - 82, comments - 269, trackbacks - 0, articles - 1
  BlogJava :: 首页 :: 新随笔 :: 联系 :: 聚合  :: 管理

单词缩写应该使用怎样的命名规范?

Posted on 2007-05-14 10:05 itspy 阅读(4563) 评论(9)  编辑  收藏 所属分类: 不谈技术小巧实例

XML,HTTP,ID,HTML。在开发中,你遇到这些缩写字符,你是如何对其命名的呢,是全部大写,还是只大写第一个字符?


你对这个问题困惑过吗? 


我一直被这个问题困惑,对于我来说经历了如下三个阶段:

  1. 最初是使用全部大写,比如XML,HTTP,ID。
  2. 可是后来我再W3C标准里面遇到了这样一个函数,getElementById(),这里面使用的Id,也就是只大写第一个字符,从这个时候开始,我使用只大写第一个字符的命名习惯。
  3. 可是最近我又发现了一些其它的标准命名习惯:innerHTML,HTTPXmlRequest。这下我真不知道怎么办了,在innerHTML,它全部大写了缩写字符。更搞笑的是HTTPXmlRequest的命名,这个命名自想矛盾,HTTP是全部大写,而第二个Xml则是大写了第一个字符。

本文首发于 http://blog.openj.cn

总结:getElementById,innerHTML,HTTPXmlRequest从这一系列标准开发包的命名习惯中,我实在总结不出规律,一个好的命名习惯,给开发会带来方便,我想开发过程中,大家多少也遇到过这类大小写问题。
连这些标准都在这方面无法统一,我们底层的开发人员真不知道如何去适从了。


注:我上面的命名例子来源
getElementById--->w3c
innerHTML--->微软自己引入的,后来被被其它浏览器所接收
HTTPXmlRequest--->没查到是哪个取的名字,是在AJAX开发时最核心对象。


评论

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-14 10:32 by Welkin Hu
这两种标准都是存在的。其实也说不上是标准,两种最多人用的约定而已。随便选一种跟就可以。不过你得和你的团队一致。

我的习惯是:
* 文档中是以单词的形式出现,一定要全部大写:ID, HTML。
* 代码中是驼峰法命名的一个部分,应首字母大写:getId, innerHtml。
* 文件名中全部小写。

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-14 10:40 by 我心依旧
这个应该是个习惯问题吧,主要看团队有没有硬性的规定.如果没有按照自己的编程风格来吧.所写还是全大写直观一些.

# re: 单词缩写应该使用怎样的命名规范?[未登录]  回复  更多评论   

2007-05-14 11:11 by 差沙
Id是一个单词的简写,HTML是几个单词的首字母。
所以可以理解一个是首字母大写,一个是全部大写。
而Xml则是特殊的单词(首)字母简写,X不是首字母。所以。。。 无所谓了。

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-14 11:43 by 刘甘泉
我的命名习惯
var Ajax=new Object();
function Ajax(obj){this.obj=obj}
//当声明为一个object或者一个'类'时,用头字母大写,如果有名词,名词全部大写


其他的都是头字母小写,insertHTML 这样

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-14 15:01 by cresposhi
其实你举的这几个例子都是可以按照同一的标准解释的。
例如HTML XML等属于专有名词缩写,抽取重要单词里的字母拼凑在一起,如果每个单词占有同样地位那么都用大写,如果是连词,比如of等就用小写,如IoC。英语里面其实就是这样缩写的。
至于getElementById innerHTML这些属于API的变量或者方法命名普遍采用的是驼峰式,而HTML这样的专有缩写还是全部大写,至于id是写成ID还是Id其实计较的必要性不大,它和HTML XML这样的专有名词还是有区别的。
其实最难理解的可能是HTTPXmlRequest,其实这里的XML也应该全部大写,也就是HTTPXMLRequest,这个时候HTTP和XML就区分不开了,所以把连续的两个缩写后面一个改成Xml也是符合驼峰式的规则的。
命名计较太多无意,重点是能在一定范围内同一,并且容易区分就好。
小弟拙见:)

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-14 15:18 by itspy
@Welkin Hu


代码中是驼峰法命名的一个部分,应首字母大写:getId, innerHtml。

innerHtml就错了,在JS中,只能是innerHTML

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2007-05-15 09:13 by Welkin Hu
@itspy
呵呵,innerHtml只是我举的一个例子而已。人家已经命好名的东西就按人家的来好了。不要太执着。

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2008-09-12 16:05 by UMU
http://msdn.microsoft.com/zh-cn/library/ms229043.aspx
微软的标准可以参考

# re: 单词缩写应该使用怎样的命名规范?  回复  更多评论   

2014-09-01 11:13 by blabla
看来是规范的,听三楼说的是这么个理由,HTML是4个单词组成的,所以这里每一个字符都属于各自单词的首字母,所以全大写,Id是一个单词的缩写,小写d是该单词内的字母,所以小写。

只有注册用户登录后才能发表评论。


网站导航: