代码规范java 代码规范检查工具

北大青鸟java培训:如何规范自己的代码编辑方式?

对于程序员来说,养成良好的代码写作能力是非常重要的。

创新互联坚持“要么做到,要么别承诺”的工作理念,服务领域包括:网站建设、成都网站制作、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的鼓楼网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!

今天,我们就一起来了解一下,规范化的代码编写都有哪些要求。

希望通过对本文的阅读,能够提高大家对于代码规范的认识。

1.保证代码压缩后不出错对于大型的JSP项目,一般会在产品发布时对项目包含的所有JSP文件进行压缩处理,比如可以利用GoogleClosureCompilerService对代码进行压缩,新版jQuery已改用这一工具对代码进行压缩,这一般会去掉开发时写的注释,除去所有空格和换行,甚至可以把原来较长的变量名替换成短且无意义的变量名,这样做的目的是加快文件的下载速度,同时也减小网站访问带来的额外数据流量,另外在代码保护上也起到了一点点作用,至少压缩后的代码即使被还原还是没那么容易一下读懂的。

要想代码能正确通过压缩,一般要求语句都要以分号正常结束,大括号也要严格结束等,具体还要看压缩工具的要求。

所以如果一开始没有按标准来做,等压缩出错后再回去找错误那是浪费时间。

2.保证代码能通过特定IDE的自动格式化功能一般较为完善的开发工具(比如AptanaStudio)都有代码"自动格式"化功能,这一功能帮助实现统一换行、缩进、空格等代码编排,你可以设置自己喜欢的格式标准,比如左大括号{是否另起一行。

达到这个要求的目的在于方便你的开发团队成员拿你代码的一个副本用IDE自动格式化成他喜欢或熟悉的风格进行阅读。

你同事需要阅读你的代码,可能是因为你写的是通用方法,他在其它模块开发过程中也要使用到,阅读你的代码能深入了解方法调用和实现的细节,这是简单API文档不能达到的效果。

3.使用标准的文档注释这一要求算是基本的,这有利于在方法调用处看到方法的具体传参提示,也可以利用配套文档工具生成html或其它格式的开发文档供其他团队成员阅读,你可以尝试使用jsdoc-toolkit。

如果你自动生成的API是出自一个开放平台,就像facebook点抗 应用,那么你的文档是给天下所有开发者看的。

另外编写完整注释,也更方便团队成员阅读你的代码,通过你的参数描述,团队成员可以很容易知道你编写的方法传参与实现细节。

当然也方便日后代码维护,这样即使再大的项目,过了很长时间后,回去改点东西也就不至于自己都忘记了当时自己写的代码是怎么一回事了。

4.使用规范有意义的变量名使用规范有意义的变量名可以提高代码的可读性,作为大项目开发成员,自己写的代码不仅仅要让别人容易看懂。

电脑培训认为开发大项目,其实每个人写的代码量可能都比较大,规范命名,日后自己看回自己的代码也显的清晰易懂,比如日后系统升级或新增功能,修改起代码来也轻松多了。

如果到头发现自己当初写的代码现在看不太懂了,那还真是天大的笑话了。

北大青鸟java培训:程序员如何规范代码的编写方法?

对于每个程序员来说,养成良好的代码编写方法是非常关键的。

在编写代码的过程中,每个人的方法是不同的,那么应该如何规范自己代码编写的方法呢?规范编写代码有哪些要求呢?下面电脑培训带大家认识代码编写的方法。

一、保证代码压缩后不会出错对于大的JavaScript项目,一般来说,包含在项目中的所有JavaScript文件在产品公开时都会被压缩。

为了正确压缩代码,通常需要考虑压缩工具的必要条件,如句子用分号正常结束,中括号结束等。

因此,IT培训发现当编写代码没有按照标准进行时,在发生压缩错误后再次寻找错误是浪费时间的。

二、保证代码能够通过自动格式化功能一般情况下需要使用完善的开发工具进行自动化格式功能,这个功能能够进行换行、缩进和空格等方法的代码编排,并且还可以设置自己喜欢的格式。

别人在阅读你的代码时需要使用IDE进行格式转换,以满足个人的阅读风格。

福建北大青鸟认为阅读代码能够更加深入的了解代码调用和细节的实现,这是简单的文档不能实现的。

三、使用标准的文档注释这是编写代码中最基本的要求,能够很好的了解代码的提示,并且还可以利用配套的文档工具生产其他格式让别人阅读。

北大青鸟认为编写完整的注释还可以使团队成员更容易阅读您的代码。

通过您的参数描述,团队成员很容易了解您想要传递参与实现细节和编写的方法。

为什么要遵守Java代码规范?

在进行Java代码敲写的时候,我们知道是有很多的Java代码规范是需要遵守的,但是有的Java学员就老是忘记,还有的Java学员是不屑遵守的,内心想着是只要我的Java代码OK,遵不遵守Java代码规范,有什么问题呢?其实是存在问题的,为什么要遵守Java代码规范?

为什么要遵守Java代码规范?当你第一次接触到Java代码规范的时候,你是不是觉得很麻烦呢?比如关于统一的原则,一再的强调,但是你一再的忘记,或者压根就不想照做,会出现什么样的后果呢?今天云南java培训将借Java代码规范中的统一来说说,自己对为什么要遵守Java代码规范,发表自己简单的看法。

Java代码规范中的统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用supplier,也可以用provider,但是我们只能选定一个使用,至少在一个Java项目中保持统一。统一是作为重要的,如果对同一概念有不同的表示方法,会使代码混乱难以理解。即使不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一次。

而如果你在一个项目中不遵守已经制定好的统一规范,那么不仅是给自己带来麻烦,也是给其他工作人员带来不便,在要进行整理的时候,你的不同,会带来不必要的交流麻烦。作为一个Java程序员,你一般是属于团队中的一员,你不遵守制定好的Java代码规范,其他人也不遵守那么你们的团队就得乱套了,所以面对Java代码规范的学习,不要觉得无趣,还是得用心记住,并且予以遵守。

java编码规范有哪些?

尽量使用完整的英文描述符,采用适用于相关领域的术语,采用大小写混合使名字可读。

JAVA代码规范:

(1)类名首字母应该大写。字段、方法以及对象(句柄)的首字母应小写。对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。例如:

ThisIsAClassName

thisIsMethodOrFieldName

若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。这样便可标志出它们属于编译期的常数。Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。对于域名扩展名称,如com,org,net或者edu等,全部都应小写(这也是Java1.1和Java1.2的区别之一)。

(2)为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义:equals()

hashCode()

toString()

clone()(implement Cloneable)

implement Serializable

(3)对于自己创建的每一个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。为使用一个项目中的类,我们没必要删除测试代码。若进行了任何形式的改动,可方便地返回测试。这些代码也可作为如何使用类的一个示例使用。

(4)应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。理想情况下,方法应简明扼要。若长度很大,可考虑通过某种方式将其分割成较短的几个方法。这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同样的一件事情)。

(5)设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)。然后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单)。

(6)使类尽可能短小精悍,而且只解决一个特定的问题。下面是对类设计的一些建议:

一个复杂的开关语句:考虑采用"多形"机制

数量众多的方法涉及到类型差别极大的操作:考虑用几个类来分别实现

许多成员变量在特征上有很大的差别:考虑使用几个类

(7)让一切东西都尽可能地"私有"-private。可使库的某一部分"公共化"(一个方法、类或者一个字段等等),就永远不能把它拿出。若强行拿出,就可能破坏其他人现有的代码,使他们不得不重新编写和设计。若只公布自己必须公布的,就可放心大胆地改变其他任何东西。在多线程环境中,隐私是特别重要的一个因素-只有private字段才能在非同步使用的情况下受到保护。

(8)谨惕"巨大对象综合症。对一些习惯于顺序编程思维、且初涉OOP领域的新手,往往喜欢先写一个顺序执行的程序,再把它嵌入一个或两个巨大的对象里。根据编程原理,对象表达的应该是应用程序的概念。


网页标题:代码规范java 代码规范检查工具
本文来源:http://scyanting.com/article/ddsgigg.html