代码规范书籍

代码规范书籍篇一:代码书写规范Web技术中心代码规范前言软件的长期价值直接源于其编码质量。在它的整个生命周期里,一个程序可能会被许多人阅读或修改。如果一个程序可以清晰的展现出它的结构和特征,那就能减少在以后对其进行修改时出错的可能性,编程规范可以帮助程序员们增加程序的健壮性。基本所有的前端代码都是暴露给公众的,所以我们更应该保证其质量。规范理念Anyviolationtothisguideisallowedifitenhancesreadability.所有的代码都要变成可供他人容易阅读的。--引用自DojoJavascript语法规范规范详解JS命名规范必须使用Tab键进行代码缩进,以节约代码大小,建议设置xx器的tab为4个空格的宽度(而不是4个空格)接口风格其他建议风格,非必要所有语句结束后,必须使用;号结束所有变量必须是有意义的英文,严厉禁止拼音变量允许使用公认英文缩写类命名必须是驼峰式常量必须所有单词大写,并且每个单词间加下划线枚举类型时,枚举的命名必须有意义,枚举与枚举成员必须以驼峰式?常量和枚举必须在最前端定义,merge时注意,必须把常量与枚举定义的文件放在文件列表的第一位?变量内的简写单词如果在开头则全小写:xmlDocument,如果不在开头则全大写:loadXML!!!?"on"只能用作事件的命名?函数开头必须是有意义的动词或动词短语?私有类的变量属性成员建议使用混合式命名,并前面下下划线?临时的全局变量放到一个全局的哈希表里,方便变量回收?所有全局变量必须初始化,尽量少用全局变量?大括号前面不能有换行符?保留字以及特有的dom属性不能作为变量名特殊命名约定?前面加“is”的变量名应该为布尔值,亦可使用“can”“has”“should”?前面加”str”的变量名应该为字符串?前面加“arr”的变量名应该为数组?前面加“num”或“count”的变量名应该为数字?“o”作为局部变量或参数,表示为Object?“e”作为局部变量或参数,表示为Element?“evt”作为局部变量或参数,表示为event?“err”作为局部变量或参数,表示为error?重复变量建议使用"i","j","k"(依次类推)等名称的变量?能缩写的单词尽量缩写?避免产生令人误解的布尔值isNotNumberisNan?处理错误的变量,必须在后面跟着“Error”?初始化用的函数必须使用“init”开头,如果一个页面只有初始化可以单独使用init?尽量做有意义的代码折行,不要让一行代码过长。?操作符建议使用空格隔开?函数调用和方法避免使用空白?逗号(,)建议使用空白隔开。?不允许频繁使用previousSibling和nextSibling词法结构?普通代码段应该看起来如下:while{}doSomething;isDone=moreToDo;?变量定义方法如下:vara=null,b=1,c=0;?函数定义方法如下:varfuncA=function{vara=0;...}?if语句应该看起来像这样:if{}statements;statements;statements;}elseif{}else{?for语句应该看起来像这样:for{}statements;?while语句应该看起来像这样:while{}doSomething;isDone=moreToDo;?do...while语句应该看起来像这样:do{statements;}while;?switch语句应该看起来像这样:switch{}case"A":statements;statements;break;statements;break;//注释case"B":default:?try...catch语句应该看起来像这样:try{}statements;statements;statements;}catch{}finally{?单行的if-else,while或者for语句也必须加入括号:if{}while{}statement;statement;for{}statement;注释规范?一些你不打算给其他人使用的函数,建议添加@ignore让文档输出时可以忽略这段注释?一些相关的功能相关的函数,建议加上@seeFunction来对上下文做索引?对于一些函数不建议或则需要注意的使用方法,必须加上@deprecated作为提醒?每个js文件的文件头都必须包含@fileoverview@author,建议加上@version?每个函数都必须使用JsDoc来注释他的用意?每个带参数的函数必须包含@param?每个有返回值的函数必须包含@return?构造函数必须加上@constructor?继承函数建议加上@base表示其继承于哪个类?常用全局变量建议使用JsDoc的注释方式?一般的变量及局部变量才用//方式进行注释,建议在需要做注释的语句的上一行?其他详情请参考JsDoc注释方法其他?String优化循环体内的字符串累加使用join方式。例如:v...

1、当您付费下载文档后,您只拥有了使用权限,并不意味着购买了版权,文档只能用于自身使用,不得用于其他商业用途(如 [转卖]进行直接盈利或[编辑后售卖]进行间接盈利)。
2、本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供参考,付费前请自行鉴别。
3、如文档内容存在侵犯商业秘密、侵犯著作权等,请点击“举报”。

常见问题具体如下:

1、问:已经付过费的文档可以多次下载吗?

      答:可以。登陆您已经付过费的账号,付过费的文档可以免费进行多次下载。

2、问:已经付过费的文档不知下载到什么地方去了?

     答:电脑端-浏览器下载列表里可以找到;手机端-文件管理或下载里可以找到。

            如以上两种方式都没有找到,请提供您的交易单号或截图及接收文档的邮箱等有效信息,发送到客服邮箱,客服经核实后,会将您已经付过费的文档即时发到您邮箱。

注:微信交易号是以“420000”开头的28位数字;

       支付宝交易号是以“2024XXXX”交易日期开头的28位数字。

客服邮箱:

biganzikefu@outlook.com

所有的文档都被视为“模板”,用于写作参考,下载前须认真查看,确认无误后再购买;

文档大部份都是可以预览的,笔杆子文库无法对文档的真实性、完整性、准确性以及专业性等问题提供审核和保证,请慎重购买;

文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为依据;

如果您还有什么不清楚的或需要我们协助,可以联系客服邮箱:

biganzikefu@outlook.com

常见问题具体如下:

1、问:已经付过费的文档可以多次下载吗?

      答:可以。登陆您已经付过费的账号,付过费的文档可以免费进行多次下载。

2、问:已经付过费的文档不知下载到什么地方去了?

     答:电脑端-浏览器下载列表里可以找到;手机端-文件管理或下载里可以找到。

            如以上两种方式都没有找到,请提供您的交易单号或截图及接收文档的邮箱等有效信息,发送到客服邮箱,客服经核实后,会将您已经付过费的文档即时发到您邮箱。

注:微信交易号是以“420000”开头的28位数字;

       支付宝交易号是以“2024XXXX”交易日期开头的28位数字。

文秘专家
机构认证
内容提供者

1

确认删除?