javascript组件控件开发接口规范发文

lightpig 发布于 2014/09/23 14:36
阅读 1K+
收藏 5

本文目的:为了使得javascript组件控件开发、选择、使用变得更加高效。

 

使用javascript开发的组件、控件各式各样,琳琅满目,五花八门。比如tree控件就有各种各样,表格控件更不用说,其他控件不需一一赘述。

在开发项目时,你或者你们的团队在开发、选取、使用控件上花费了多少冤枉时间?这个控件没有那样的功能,那个控件没有这样的功能,各种控件样式不统一……于是,你们选择了某种框架:jQuery-easyuiextjsDojo等,解决了样式风格统一的问题以及其他一些问题。但仍有不如意:选取的框架中没有这样的控件,或者框架中控件自身的限制无法完成某种功能,又或者下一个项目又想要用另一个框架,每个前端框架都限制了组件控件的灵活选取与应用,这些问题,使得前台开发变得麻烦。

 

既然TA已经开发出了一种控件,你却不用,还要自己再写?既然我已经写好了一个很灵活的通用组件放到网上,为什么还是一个又一个同样功能的代码被贴到的网络上来?为什么要做重复的事情?何必让自己的编程生活变得毫无意义?

 

       为了使得javascript组件控件开发、选择、使用变得更加高效:

下面是我提出的开发规范:

本规范的范围:javascript组件控件开发与使用

开发出的控件:

 

1.       控件必须写上对象注释,方法注释,使用方法,使用举例。注释要极力简洁准确清楚,能使使用者以最短的时间理解和使用,不要让使用者需要阅读代码才明白使用方法。

2.       控件样式必须有cssjavascript对象两种设置的接口(通过css文件或javascript对象设置其样式)

3.       控件注册到页面中时,除相关引用代码只可关联一个标签

4.       控件必须可以通过javascript对象进行访问使用,包括属性获取,设置。

 

如果按这样的规范接口开发的控件,可以在项目开发中随意选取控件修改样式改善成统一的样式风格,并且可以任意选取合适的控件,再有新的类型控件,应用到项目中也更为容易,并且不用不断学习各种框架。

      

这几点规范自然不足的很。但有一点点规范,便会产生出来一点点通用的东西,一点点通用的东西好处自然不必我说。如果大家都按一点点规范出发做事,对所有人都会带来很大裨益。无论你是团队,还是个人,如果你看到,那就讨论一点什么或者遵守一点点!如果大家能完善这点点规范,出来的会是更规范的有用的东西,以及更灵活更有生命力的产品。

 

       大家可以讨论提出更多详细规范,我们不需要制定出优秀的规范,因为每多一点点统一我们就获益不少,完善一点规范遵守一点规范就这样点滴向前。

       你如果要开发控件,就在你的控件代码说明中贴上此规范,告诉他人,这个规范放在何处,让更多人遵守,产生更多统一的控件。

 

程序员不仅是逻辑能力强的,而且还是表达能力强的,编写的代码写上让别人以最少的时间能够明白它的注释!

这是一个集体智慧的时代,你的智慧就是我的智慧,我的智慧就是你的智慧,我的智慧就是集体的智慧,集体的智慧就是我的智慧。


加载中
0
lightpig
lightpig

简要版:

本文目的:为了使得javascript组件控件开发、选择、使用变得更加高效:

下面是我提出的开发规范:

本规范的范围:javascript组件控件开发与使用

开发出的控件:

 

1.       控件必须写上对象注释,方法注释,使用方法,使用举例。注释要极力简洁准确清楚,能使使用者以最短的时间理解和使用,不要让使用者需要阅读代码才明白使用方法。

2.       控件样式必须有cssjavascript对象两种设置的接口(通过css文件或javascript对象设置其样式)

3.       控件注册到页面中时,除相关引用代码只可关联一个标签

4.       控件必须可以通过javascript对象进行访问使用,包括属性获取,设置。

大家可以讨论提出更多详细规范,我们不需要制定出优秀的规范,因为每多一点点统一我们就获益不少,完善一点规范遵守一点规范就这样点滴向前。

       你如果要开发控件,就在你的控件代码说明中贴上此规范,告诉他人,这个规范放在何处,让更多人遵守,产生更多统一的控件。



0
lightpig
lightpig

因为曾使用过easyUI,有很多属性是无法访问设置的,封装以及在项目中使用及其不方便,不像extjs,dojo那样好用,然而extjs,dojo 这些框架中的控件有只他们自己统一的风格样式,想要匹配其他零星的控件的样式,以求软件风格一致,又很困难。

现在单独的控件很强大,很好用,但就是风格不一致,如果有设置样式的接口,边可以自己调节其风格,而不需要依赖框架的控件而被束缚到框架中而不能使用优秀的单一控件。

0
lightpig
lightpig
鉴于可编辑的原因,我将规范放在下面的网络位置,有意见或者需要修改规范的可去回复讨论并我来修改发布:http://www.cnblogs.com/lightpig2015bolg/p/3988583.html
遵守它很容易,带来的好处是广泛的,很有价值的。希望看到的人一起努力。
返回顶部
顶部