十年网站开发经验 + 多家企业客户 + 靠谱的建站团队
量身定制 + 运营维护+专业推广+无忧售后,网站问题一站解决
对于程序员来说,养成良好的代码写作能力是非常重要的。
创新互联坚持“要么做到,要么别承诺”的工作理念,服务领域包括:网站制作、成都网站设计、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的中山网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!
今天,我们就一起来了解一下,规范化的代码编写都有哪些要求。
希望通过对本文的阅读,能够提高大家对于代码规范的认识。
1.保证代码压缩后不出错对于大型的JSP项目,一般会在产品发布时对项目包含的所有JSP文件进行压缩处理,比如可以利用GoogleClosureCompilerService对代码进行压缩,新版jQuery已改用这一工具对代码进行压缩,这一般会去掉开发时写的注释,除去所有空格和换行,甚至可以把原来较长的变量名替换成短且无意义的变量名,这样做的目的是加快文件的下载速度,同时也减小网站访问带来的额外数据流量,另外在代码保护上也起到了一点点作用,至少压缩后的代码即使被还原还是没那么容易一下读懂的。
要想代码能正确通过压缩,一般要求语句都要以分号正常结束,大括号也要严格结束等,具体还要看压缩工具的要求。
所以如果一开始没有按标准来做,等压缩出错后再回去找错误那是浪费时间。
2.保证代码能通过特定IDE的自动格式化功能一般较为完善的开发工具(比如AptanaStudio)都有代码"自动格式"化功能,这一功能帮助实现统一换行、缩进、空格等代码编排,你可以设置自己喜欢的格式标准,比如左大括号{是否另起一行。
达到这个要求的目的在于方便你的开发团队成员拿你代码的一个副本用IDE自动格式化成他喜欢或熟悉的风格进行阅读。
你同事需要阅读你的代码,可能是因为你写的是通用方法,他在其它模块开发过程中也要使用到,阅读你的代码能深入了解方法调用和实现的细节,这是简单API文档不能达到的效果。
3.使用标准的文档注释这一要求算是基本的,这有利于在方法调用处看到方法的具体传参提示,也可以利用配套文档工具生成html或其它格式的开发文档供其他团队成员阅读,你可以尝试使用jsdoc-toolkit。
如果你自动生成的API是出自一个开放平台,就像facebook.com应用,那么你的文档是给天下所有开发者看的。
另外编写完整注释,也更方便团队成员阅读你的代码,通过你的参数描述,团队成员可以很容易知道你编写的方法传参与实现细节。
当然也方便日后代码维护,这样即使再大的项目,过了很长时间后,回去改点东西也就不至于自己都忘记了当时自己写的代码是怎么一回事了。
4.使用规范有意义的变量名使用规范有意义的变量名可以提高代码的可读性,作为大项目开发成员,自己写的代码不仅仅要让别人容易看懂。
电脑培训认为开发大项目,其实每个人写的代码量可能都比较大,规范命名,日后自己看回自己的代码也显的清晰易懂,比如日后系统升级或新增功能,修改起代码来也轻松多了。
如果到头发现自己当初写的代码现在看不太懂了,那还真是天大的笑话了。
这个如果单单拿出来说,确实没有太大的意义,要看具体业务
比如说你数据库里的一个数据列类型是DATE,而JAVA里是字符串,业务上会要求你以什么格式存放这个数据,那么你就要先将字符串格式化成这个格式,然后再将这个格式转换成数据库里相应的DATE类型存入
格式化是根据业务需要进行的。像时间字符串或者特殊意思的ID,对他们进行格式化后能更方便的进行比较、转换或者理解。而格式化就是根据特定的格式进行处理,将原来的字符串转为给定格式的字符串。