前端javascript编写规范

dot fish say code in self style !

导语:

为了便于前端JavaScript的开发和维护,编写出的代码是易读易懂的,并确保在团队中的所有成员杜能保持相似的编程风格,除了js规定的固有规则外,我们会规定规定一些自己的团队编码风格,方便团队的代码维护及团队的持续发展。


编写规范

命名规范
  • 变量名使用描述性的名字*
  • 以小写字母开头,采用驼峰命名分割单词*
  • 全局常量使用全大写的名字*
  • 将jQuery选择器返回的内容存进变量以便重用
    var $myDiv = $("#myDiv");
    $myDiv.click(function(){...});
    


#####编写规范
- 程序块要采用缩进风格编写,缩进的空格数为4个;
- 所有的语句中都使用分号;
- 相对独立的程序块之间、变量说明之后必须加空行。
- 较长的语句(>80字符)要分成多行书写
    ```
  perm_count_msg_head_len = NO7_TO_STAT_PERM_COUNT_LEN   
                              + STAT_SIZE_PER_FRAM * 10;

  if  ((taskno < max_act_task_number)
        && (n7stat_stat_item_valid (stat_item))){ 
        ... // program code
   } 
    ```
- 大括号形式
  ```
 // bad
function hello(){
...
}
// good
function hello() {
...
}
  ```
- 新建一个对象

// bad
var obj = new Object();
// good
var obj = {};

  - 新建一个数组

// bad
var arr = new Array();
// good
var arr = [];


  -  优先使用单引号
        ```
// bad
var name = "joker";
// good
var name = 'joker';
        ```
  -  当字符串较长时

// good
var str = '';
str += '<header>' + header + '</header>';
str += '<token>' + token + '</token>';
str += '<url>' + url + '</url>';
...
```

  • && 与 || 尽量避免右边使用具有副作用(赋值、递增、递减和函数调用)的表达式
// bad
if( a++ > 10 && !a ) {
}
if( !a || b++ > 10 ) {
}
// good 
if( !a && a++ > 10 ) {
}
if( b++ > 10 || !a ) {
}
        ```
  -  当同时定义多个变量时

// bad
var _qQuery = window.jQuery;
var _$ = window.$;
var class2type = {};
// good
var _jQuery = window.jQuery,
_$ = window.$,
class2type = {};


  -  单行注释,放在被注释语句,函数的上一行,并且与其对齐,注释前空一行

// Trigger any bound ready events
if ( jQuery.fn.trigger ) {
jQuery( document ).trigger("ready").off("ready");
}

---         <未完待续>             
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,524评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,869评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,813评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,210评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,085评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,117评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,533评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,219评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,487评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,582评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,362评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,218评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,589评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,899评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,176评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,503评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,707评论 2 335

推荐阅读更多精彩内容