java代码规范模板
- 格式:doc
- 大小:292.00 KB
- 文档页数:9
Java编码书写规范目录1.命名约定11.1.一般概念1 1.2.示范12.注释约定42.1.一般概念4 2.2.示范4 2.3.注释范围53.文件样式约定63.1.J A V A(*.JA V A) 6 3.1.1.版权信息6 3.1.2.P ACKAGE/I MPORTS6 3.1.3.C LASS7 3.1.4.C LASS F IELDS7 3.1.5.构造函数8 3.1.6.克隆方法8 3.1.7.类方法(类的普通成员函数)9 3.1.8.TO S TRING 方法9 3.1.9.MAIN 方法10 3.2.J A V A S ERVER P AGE(*.JSP) 10 3.2.1.版本信息10 3.2.2.TAG11 3.2.3.值输出11 3.2.4.嵌入代码段114.其它代码书写风格约定124.1.文档自动生成12 4.2.缩进12 4.3.页宽12 4.4.变量声明14 4.5.变量初始化14 4.6.局部变量声明15 4.7.空行15 4.8.大括号{} 15 4.9.小括号()154.10.运算符16 4.11.参数间隔16 4.12.JSP文件命名16 4.13.S ERVLET类命名(待定)165.编码指南165.1.对实例以及类变量的访问控制16 5.2.引用类变量和类方法17 5.3.常量17 5.4.变量赋值17 5.5.其它惯例18 5.5.1.圆括号18 5.5.2.返回值18 5.5.3.条件运算符"?"前的表达式19 5.5.4.特殊注释19 5.5.5.异常使用原则201.命名约定除了以下几个特例之外,命名时必须始终采用完整的英文描述符。
此外,一般应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。
1.1. 一般概念☞尽量使用完整的英文描述符☞采用适用于相关领域的术语☞采用大小写混合使名字可读☞尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一☞避免使用长的名字(尽量小于25 个字母)☞避免使用类似的名字,或者仅仅是大小写不同的名字☞避免使用下划线(除静态常量等)1.2. 示范包(Package)采用完整的英文描述符,应该都是由小写字母组成,格式为com.dcosft.*。
java 代码规范Java代码规范是为了提高代码的可读性、可维护性和可扩展性而制定的一系列约定。
遵循代码规范能够提高团队合作的效率,使代码更易于理解和调试。
1. 命名规范:- 类名和接口名使用大驼峰命名法,即每个单词首字母大写,如`MyClass`;- 方法名和变量名使用小驼峰命名法,即第一个单词首字母小写,其他单词首字母大写,如`myMethod`;- 常量名使用全大写,并用下划线分隔单词,如`MAX_COUNT`;- 缩写词只能用首字母,如`createURL`。
2. 缩进与空格:- 使用4个空格进行缩进,不使用Tab键;- 运算符前后留一个空格,如`a = b + c`;- 每行代码长度不超过80字符。
3. 大括号:- 大括号另起一行,并且与前面的代码保持一个空格的间距;- 例外情况是单行代码块可以省略大括号。
4. 注释规范:- 使用Javadoc格式的注释对类、接口、方法进行文档化,包括描述、参数、返回值等内容;- 对于代码的解释,可以使用单行或多行注释,但要注意不要过度注释。
5. 继承与接口:- 只有当类与接口之间有明确的"is-a"关系时,才使用继承;- 当多个类具有相同的行为时,使用接口进行实现。
6. 异常处理:- 必须捕获异常或者在方法签名中声明抛出异常,不要使用空的catch块;- 在catch块中至少包含对异常的简要说明和处理过程。
7. 方法规范:- 方法应该具有明确的功能,只完成一个任务;- 方法长度不超过40行,尽量保持简短。
8. 避免使用魔术数字:- 将常用的数字定义为常量,以便于代码的理解和维护。
9. 使用合适的数据结构:- 使用集合类或者数组来存储多个相同类型的数据;- 使用枚举类型来表示一组常量。
10. 错误处理与日志:- 合理处理异常,避免出现未捕获的异常;- 使用日志记录程序运行过程中的关键信息。
以上是一些较为常见的Java代码规范,但实际上还有很多方面需要考虑。
java编码规范文档# Java编码规范文档。
一、前言。
小伙伴们!当我们一起在Java的世界里畅游时,要是大家都按照一套约定俗成的编码规范来写代码,那我们的代码就像训练有素的军队一样,整齐又高效。
这份规范就是我们在Java编程旅程中的小指南,让我们的代码既容易理解,又方便维护。
二、命名规范。
# (一)包(package)命名。
1. 包名应该全部小写,用点(.)分隔单词。
就像你的小包裹要摆放得井井有条一样,包名也得规规矩矩。
例如:`com.example.myproject`,这看起来多清爽。
如果写成`Com.Example.MyProject`,那就像穿着奇装异服的士兵混在整齐的队伍里,很不协调。
# (二)类(class)命名。
1. 类名采用大驼峰命名法(UpperCamelCase),每个单词的首字母大写,不要包含下划线或者其他奇怪的符号。
这就好比给每个班级取一个正式又响亮的名字。
比如:`MyFirstClass`,而不是`my_first_class`或者`my first class`。
那些奇怪的写法就像给班级取个让人摸不着头脑的名字,可不好。
# (三)方法(method)命名。
1. 方法名采用小驼峰命名法(lowerCamelCase),第一个单词小写,后面每个单词首字母大写。
这就像给方法这个小助手取个清晰明了的名字,方便我们知道它是干什么的。
例如:`calculateSum`,而不是`Calculate_Sum`或者`CALCULATESUM`。
要是写成后面那种,就像一个小助手穿着奇装异服,你都不知道它是来帮忙做什么的。
# (四)变量(variable)命名。
1. 变量名同样采用小驼峰命名法。
变量就像一个个小盒子,我们得给它们取个能让人一眼就大概知道里面装什么东西的名字。
像`studentName`,你一看就知道这个变量可能是用来存学生名字的。
要是写成`student_name`或者`STUDENTNAME`,就有点让人迷糊啦。
封面作者:Pan Hongliang仅供个人学习Java代码规范前言:为提高软件开发的质量和速度、增强代码的可读性、统一编程人员在实际工作中的代码编写风格,特此制定出本团队的代码规范,希望各位同仁认真阅读、严格遵守本规范。
本规范由ncs-网络事业部维护。
规范等级说明∙级别I: 默认级别,要求所有项目中的所有成员遵守。
∙级别II: 建议所有项目中的所有成员遵守。
∙级别III: 鼓励各个项目根据实际情况执行。
1.格式与命名规范(Formating and Naming Conventions)1.1 缩进使用Tab缩进,而不是空格键--将缩进2,4,8字符的选择权留给阅读者。
1.2 换行每行120字符--因为已是1024*768的年代。
if,for,while语句只有单句时,如果该句可能引起阅读混淆,需要用" {"和"}"括起来,否则可以省略。
//错误,需要使用花括号{}括起来if (condition)if(condition) doSomething();elsedoSomething();1.3 命名规则∙不允许使用汉语拼音命名∙遇到缩写如XML时,仅首字母大写,即loadXmlDocument()而不是loadXMLDocument()∙Package名必须全部小写,尽量使用单个单词∙为了基于接口编程,不采用首字母为I或加上IF后缀的命名方式,如IBookDao,BookDaoIF。
∙页面部件名建议命名为:btnOK、lblName或okBtn、nameLbl。
( II )其中btn、lbl缩写代表按钮(Button)、标签(Label)。
∙局部变量及输入参数不要与类成员变量同名(get/set方法与构造函数除外)∙方法的名字的第1个单词应以小写字母开头,后面的单词则建议用大写字母开头。
∙常量的名字应该都使用大写字母,并且指出该常量完整含义。
如果一个常量名称由多个单词组成,则建议用下划线来分割这些单词1.4 声明∙修饰符应该按照如下顺序排列:public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp。
java代码规范Java代码规范是一套约定俗成的编程规范,旨在提高代码的可读性、可维护性和可重用性。
以下是一些常见的Java代码规范:命名规范:1. 类名使用大驼峰命名法,例如MyClass。
2. 方法名和变量名使用小驼峰命名法,例如myMethod。
3. 常量名使用全大写字母和下划线,例如MAX_VALUE。
4. 包名使用全小写字母,例如com.example.mypackage。
代码格式规范:1. 使用四个空格缩进,避免使用制表符。
2. 每行代码不超过80个字符,超出则换行。
3. 使用空格将运算符、逗号和分号与操作数分开,例如"int a =b + c;"。
4. 在左括号前后加一个空格,例如"if (condition) {"。
5. 在方法的左花括号前加空格,例如"public void myMethod() {"。
6. 使用大括号括起的代码块独占一行。
7. 在逻辑上相关的代码块之间使用空行分隔。
注释规范:1. 在类、方法和成员变量定义之前使用Javadoc注释说明其作用、参数和返回值。
2. 在方法内部使用注释解释代码的逻辑。
3. 避免使用不必要的注释,代码应尽可能自解释。
代码质量规范:1. 遵循SOLID原则,尽量将代码设计为松耦合、高内聚的模块。
2. 避免使用魔术数字,使用常量代替。
3. 使用异常处理机制来处理可预料的异常情况,不要捕获所有异常。
4. 避免使用全局变量,尽量将变量的作用范围限制在最小范围内。
5. 避免代码冗余和重复,尽量使用工具类和设计模式来重用代码。
测试规范:1. 使用单元测试框架(例如JUnit)编写测试用例,并确保每个方法都有相应的测试用例。
2. 使用断言来验证预期结果和实际结果是否一致。
3. 测试方法的命名应描述被测试方法的功能和预期结果。
版本管理规范:1. 使用版本管理工具(例如Git)来管理代码的版本和变更历史。
Java编码规范及实践目录Java编码规范及实践 (1)1.2术语 (2)1.3约束 (3)||!(condition5 && condition6)) { (14)4.1一般命名规范 (14)IQuery, IDataAccess,IReportBuilder (15)MAX_TIMES, DEFAULT_NAME (15)4.2特殊命名规范 (17)AbstractReportBuilder,AbstractBeanFactory (18)AccessException, RuntimeException (19)5.2一般原则 (20)1.代码应该和注释保持同步,如果代码和注释不同步,则阅读代码的人会 (20)2.注释尽量简洁,尺度没有准确的定义,大部分人能明白即可,可以将自 (20)Result getResult() throws Exception{ (21)Object getAction(); (22)JavaDoc 工具不要改变格式. (22)Get a default date/time formatter that uses the SHORT (23)Thread.sleep(1000); (24)Derived,如果一个方法可以接受基类对象b 的话:method1(Base b), (25)7.1工厂模式 (26)7.1.1简单工厂 (26)7.1.2工厂方法 (26)7.2单例模式 (27)Client: (27)7.3适配器模式 (28)7.4组合模式 (29)Client: (29)7.5外观模式 (30)Client: (30)7.6代理模式 (31)7.7命令模式 (32)Client: (33)7.8观察者模式 (33)7.9策略模式 (35)Client: (35)IKeyPairGenerable desGenerator = (35)IKeyPairGenerable rsaGenerator = (36)IKeyPairGenerable ideaGenerator = (36)KeyPairManager manager = new KeyPairManager(); (36)7.10模版方法模式 (36)7.11参观者模式 (38)总价格 (40)Client: (40)第1章概述1.1前言代码之于程序员,就像零件之于机械工,庄稼之于农民,它是软件的基石,一行行代码都是程序员的心血经过日日夜夜凝结成的。
JAVA代码规范本Java代码规范以SUN的标准Java代码规范为基础,为适应我们公司的实际需要,可能会做一些修改。
本文档中没有说明的地方,请参看SUN Java标准代码规范。
如果两边有冲突,以SUN Java标准为准。
1. 标识符命名规范1.1 概述标识符的命名力求做到统一、达意和简洁。
1.1.1 统一统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用supplier,也可以用provider,但是我们只能选定一个使用,至少在一个Java项目中保持统一。
统一是作为重要的,如果对同一概念有不同的表示方法,会使代码混乱难以理解。
即使不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一次。
1.1.2 达意达意是指,标识符能准确的表达出它所代表的意义,比如:newSupplier, OrderPaymentGatewayService等;而supplier1, service2,idtts等则不是好的命名方式。
准确有两成含义,一是正确,而是丰富。
如果给一个代表供应商的变量起名是order,显然没有正确表达。
同样的,supplier1, 远没有targetSupplier意义丰富。
1.1.3 简洁简洁是指,在统一和达意的前提下,用尽量少的标识符。
如果不能达意,宁愿不要简洁。
比如:theOrderNameOfTheTargetSupplierWhichIsTransfered 太长,transferedTargetSupplierOrderName则较好,但是transTgtSplOrdNm就不好了。
省略元音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写。
1.1.4 骆驼法则Java中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之间不使用特殊符号分割,而是通过首字母大写来分割。
比如: supplierName, addNewContract,而不是supplier_name, add_new_contract。
代码书写规范(Java)前几天整理出来的一个JAVA的代码书写规范!代码书写规范一、目的对于代码,首要要求是它必须正确,能够按照程序员的真实思想去运行;第二个的要求是代码必须清晰易懂,使别的程序员能够容易理解代码所进行的实际工作。
在软件工程领域,源程序的风格统一标志着可维护性、可读性,是软件项目的一个重要组成部分。
而目前还没有成文的编码风格文档,以致于很多时候,程序员没有一个共同的标准可以遵守,编码风格各异,程序可维护性差、可读性也很差。
通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。
本文在参考业界已有的编码风格的基础上,描述了一个基于JBuilder 的项目风格,力求一种统一的编程风格,并从整体编码风格、代码文件风格、函数编写风格、变量风格、注释风格等几个方面进行阐述。
(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)二、整体编码风格1、缩进缩进建议以4个空格为单位。
建议在 Tools/Editor Options 中设置Editor 页面的Block ident为4,Tab Size 为8。
预处理语句、全局数据、标题、附加说明、函数说明、标号等均顶格书写。
语句块的"{"、"}"配对对齐,并与其前一行对齐,语句块类的语句缩进建议每个"{"、"}"单独占一行,便于匹对。
JBuilder 中的默认方式是开始的"{"不是单独一行,建议更改成上述格式(在Project/Default ProjectProperties 中设置 Code Style 中选择 Braces 为 Next line)。
2、空格原则上变量、类、常量数据和函数在其类型,修饰名称之间适当空格并据情况对齐。
java 代码规范规范如下:1.包名的命名包名全部小写,连续的单词直接连接,不出现特殊符号,不使用下划线,包名中不要出现很容易区分供应商的信息参考示例:一级包名为com二级包名为tesla三级包名为应用名称:如launcher、weather等四级包名为模块名或层级名:如工具类为util、Activity类为activity例如:uncher.activity2.类的命名采用大驼峰式命名法,每个单词的首字母大写。
尽量避免缩写,除非该缩写是众所周知的,比如HTML,URL,如果类名称包含单词缩写,则单词缩写的每个字母均应大写。
例外注意命令时,区分各个组件类型。
参考示例:MainMenuActivity、SoftwareUpdateService等3.方法(函数)命名使用动词或动名词,采用小驼峰命名法。
参考示例:onCreate();4.接口命名命名规则与类一样采用命名规则与类一样采用大驼峰命名法,多以able或ible结尾参考示例:Runnable5.变量命名A.成员变量和临时变量命名:采用小驼峰命名法,第一个单词首字母小写其它单词首字母大写。
参考示例:private String userName;B.常量命名:常量使用全大写字母加下划线的方式命名,并且用final static修饰。
参考示例:private final static String TAG = “tag”;C.控件实例命名:采用小写字母加下划线方式命名,类中控件名称必须与xml布局id保持一致。
参考示例:android:id=”@+id/tv_pic_brightness_value”则对应调用的Activity中定义该控件为 private TextViewtv_pic_brightness_value;6.控件资源id命名view缩写_模块名_view的逻辑名称。
7.res资源文件命名A.布局文件命名规范:全部采用小写,采用下划线命名法。
java代码规范(三)代码格式1. 【强制】如果是⼤括号内为空,则简洁地写成{}即可,⼤括号中间⽆需换⾏和空格;如果是⾮ 空代码块则: 1)左⼤括号前不换⾏。
2)左⼤括号后换⾏。
3)右⼤括号前换⾏。
4)右⼤括号后还有 else 等代码则不换⾏;表⽰终⽌的右⼤括号后必须换⾏。
2. 【强制】左⼩括号和右边相邻字符之间不出现空格;右⼩括号和左边相邻字符之间也不出现空格;⽽左⼤括号前需要加空格。
详见第 5 条下⽅正例提⽰。
反例:if (空格 a == b 空格)3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4. 【强制】任何⼆⽬、三⽬运算符的左右两边都需要加⼀个空格。
说明:包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5. 【强制】采⽤ 4 个空格缩进,禁⽌使⽤ Tab 字符。
说明:如果使⽤ Tab 缩进,必须设置 1 个 Tab 为 4 个空格。
IDEA 设置 Tab 为 4 个空格时,请勿勾选 Use tab character;⽽在 Eclipse 中,必须勾选 insert spaces for tabs。
正例:(涉及 1-5 点)public static void main(String[] args) {// 缩进 4 个空格String say = "hello";// 运算符的左右必须有⼀个空格int flag = 0;// 关键词 if 与括号之间必须有⼀个空格,括号内的 f 与左括号,0 与右括号不需要空格if (flag == 0) {System.out.println(say);}// 左⼤括号前加空格且不换⾏;左⼤括号后换⾏if (flag == 1) {System.out.println("world");// 右⼤括号前换⾏,右⼤括号后有 else,不⽤换⾏} else {System.out.println("ok");// 在右⼤括号后直接结束,则必须换⾏}}6. 【强制】注释的双斜线与注释内容之间有且仅有⼀个空格。
java代码开发规范Java代码开发规范(Java Coding Convention)是一组编写Java 代码的规范和约定,以提高代码的可读性、可维护性和可重用性。
下面是一个包含大约1000字的Java代码开发规范概述:1. 命名规范:- 类名使用大写开头的驼峰式命名法,如MyClass。
- 方法名和变量名使用小写开头的驼峰式命名法,如myMethod。
- 常量名使用全大写字母和下划线的命名法,如MY_CONSTANT。
- 包名使用全小写字母,可以使用多级包名,如com.example.myproject。
2. 缩进和空格:- 使用4个空格进行代码块缩进。
- 除了特殊情况,每行代码最多120个字符。
- 操作符前后加上空格,如a + b。
3. 注释:- 使用Javadoc风格的类、方法和变量注释。
- 注释应该简洁明了,不要使用废话或无关信息。
- 注释应该更新以反映代码的变化。
4. 源文件:- 每个源文件只包含一个公有类。
- 源文件应该以UTF-8编码保存。
- 导入语句应该按照字母顺序排序。
5. 类的结构:- 每个类应该包含类的成员变量、构造方法、公有方法和私有方法,按照这个顺序。
- 成员变量应该使用private修饰,并提供相应的getter和setter方法。
- 公有方法应该提供必要的参数检查和异常处理。
6. 代码块:- 使用大括号包围代码块,即使代码块只有一行。
- 尽量减少嵌套层次,避免深层次的if-else或循环嵌套。
- switch语句应该包含default情况,并在每个case结束后加上break。
7. 异常处理:- 每个抛出异常的方法都应该声明可能抛出的异常类型。
- 在需要捕获异常的地方使用try-catch语句,并处理异常。
8. 并发编程:- 尽量使用线程安全的类和方法。
- 保护共享资源时使用synchronized关键字或者Lock对象。
9. 测试代码:- 每个公有类应该有相应的单元测试类。
JAVA代码开发规范1开发工具规范三代开发IDE使用Eclipse3.5,编码方式都使用UTF-8,jdk使用jdk1.6。
2排版规范1.关键词(或变量)和操作符之间加一个空格。
例如:int count = 1;//操作符和值之间有一个空格。
2.if、for、do、while、switch、方法名、类名后面跟“(”或“{”时,之间要有一个空格。
3.相对独立的代码块与块之间加空行。
例如:两个方法之间需要用空行隔开。
4.较长的语句、表达式等要分成多行书写。
5.长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
6.代码的新行与上一行根据逻辑关系要进行适应的缩进(一个table键),使排版整齐,语句易读。
7.不允许把多个短语句写在一行中,即一行只写一条语句。
8.函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。
采用table 键缩进。
9.用大括号‘{’和‘}’界定一段程序块时,编写程序块时‘{’跟在前一行语句之后,并隔一个空格,‘}’应独占一行。
10.for循环的三个表达式(初始化表达式,循环变量判定表达式,循环变量修正表达式)之间用空格分隔。
for-each中用‘:’两边加上空格。
例如:for (int i=0; i<1000; i++) 或 for (User user : userList)3命名规范1.package(包)的命名package 的名字应该都是由一个小写单词组成。
并以com.yeepay开始。
例如:package mon;2.类名的命名接口名、类名、方法名、成员变量名、方法内变量命名尽可能表达该类、方法或变量的含义。
组成类名的每个单词的首字母大写。
例如:public class DatabaseOperator {}3.class 中成员变量的命名变量的名字必须用一个小写字母开头,后面的单词首字母大写。
例如:userType, accountService。
JAVA开发规范文档引言:为了提高JAVA开发效率和可维护性,降低开发过程中的错误率,特制定此开发规范文档。
本规范适用于所有JAVA开发项目,包括前端、后端和移动端开发。
1.命名规范1.2 类名:采用驼峰命名法,首字母大写,如UserService。
1.3 方法名:采用驼峰命名法,首字母小写,如getUserList。
1.4 变量名:采用驼峰命名法,首字母小写,如userName。
1.5常量名:全部大写,使用下划线分隔,如MAX_COUNT。
1.6 接口名:采用驼峰命名法,首字母大写,如UserService。
1.7 枚举名:采用驼峰命名法,首字母大写,如ColorType。
2.注释规范2.2方法或代码块内应有必要的注释,解释方法的功能和输入输出参数的含义。
2.3注释要简洁明了,不得使用拗口难懂的词汇。
2.4注释要与代码保持同步更新。
3.代码风格规范3.1缩进:使用4个空格进行缩进,不得使用制表符。
3.2行宽:每行代码不得超过120个字符。
3.3空行:合理使用空行,以提高代码的可读性。
3.4操作符前后空格:操作符前后必须有一个空格,如a=b+c。
3.5大括号位置:大括号应该独占一行,且与前面的语句间有一个空格。
3.6代码块注释:使用//或/*...*/对代码块进行注释,描述代码块的功能和作用。
3.7异常处理:所有异常都需要捕获处理,不允许直接忽略异常。
3.8类内方法的顺序:构造方法、公有方法、私有方法,按照方法访问权限从公有到私有的顺序排列。
4.代码规范4.1不允许出现未使用的变量和方法。
4.2不允许出现硬编码的常量,应使用常量定义。
4.3 字符串拼接使用StringBuilder或StringBuffer,避免使用+操作符。
4.4尽量使用接口和抽象类进行编程,而不是具体实现类。
4.5 使用try-with-resources来释放资源,如文件流、数据库连接等。
4.6尽量使用JDK提供的集合类,避免使用原生数组。
Info DMSjava代码开发模板作者:周清江发布日期:2007-11-23当前版本:0.1上海英孚思为信息科技有限公司修订历史纪录代码开发环境修订Info DMS 英孚思为机密文件代码开发环境修订Info DMS 英孚思为机密文件代码开发环境修订 Info DMS英孚思为机密文件 Java 开发模板文件导入1. 导入统一的版权信息和类、方法、字段注释格式文件第一步 打开 Preference,选中code_style->>Code_Templates第二步选择Import …文件名:code_style_templates.xml代码开发环境修订 Info DMS英孚思为机密文件2. 导入统一代码样式文件第一步 打开 Preference,选中code_style->>Fromatter代码开发环境修订 Info DMS英孚思为机密文件第二步选择Import … 文件名:code_style_formatter.xmlFile Descript统一定义导入统一的版权信息以后当新建每个JA V A以后,JA V A文件头内容统一为:/***Copyright(c)2006-2008OEM Infoservice Corp.2006-2008,All Rights Reserved.*This software is published under the Infoservice DMS Service Inner Solution Team.*License version 1.0,a copy of which has been included with this *distribution in the LICENSE.txt file.**@File name:base.actions.MaintainBrand.java*@Create on:2007-9-30*@Author:kevin**@ChangeList*---------------------------------------------------*NO Date Editor ChangeReasons* 1.2007-9-30kevin Add**/注意:1.如果文件不是新建而是从原来的项目中拷贝过来,请修改包名和类名.(@File name:)base.actions.MaintainBrand.java2.如果因为重要的业务逻辑而修改过文件,不要忘了在(@ChangeList)加上相关修改日期、修改人和简单描述修改原因。
java基本格式Java 是一种面向对象的编程语言,以下是一些Java 的基本格式规范:1. 类名:类名应采用驼峰命名法(Camel Case),首字母大写,如`MyClass`。
2. 方法名:方法名应采用驼峰命名法,首字母小写,如`myMethod`。
3. 变量名:变量名应采用驼峰命名法,首字母小写,如`myVariable`。
4. 常量名:常量名应使用全大写字母,单词之间用下划线分隔,如`MY_CONSTANT`。
5. 缩进:使用四个空格进行缩进,不要使用制表符。
6. 行长度限制:每行代码建议限制在80 到120 个字符之间,超过这个长度可以进行换行。
7. 大括号:大括号的开头放在语句块的同一行的末尾,结束括号单独占一行。
8. 空格:在运算符、逗号、分号后面添加一个空格,增加可读性。
9. 注释:使用注释对代码进行解释和文档化,增加可读性。
10. 类和方法的结构:按照逻辑将类和方法分组,使用空行和注释来划分代码块。
下面是一个示例的Java 代码,展示了基本格式的应用:```javapublic class MyClass {private int myVariable;public void myMethod() {if (myVariable > 0) {System.out.println("Value is positive.");} else {System.out.println("Value is non-positive.");}}public static void main(String[] args) {MyClass obj = new MyClass();obj.myMethod();}}```这只是基本的格式规范,实际上在团队或项目中可能会有额外的规范要求。
建议根据团队或项目的编码规范进行统一,以保持代码的一致性和可读性。
java代码编写规范Java代码编写规范是为了保持代码的一致性、可读性、可维护性和可扩展性而制定的一套规则。
以下是一些常见的Java代码编写规范:1. 命名规范:- 类名使用大写字母开头的驼峰命名法,如MyClass。
- 方法名使用小写字母开头的驼峰命名法,如myMethod。
- 变量名使用小写字母开头的驼峰命名法,并能直观地描述变量的含义,如myVariable。
- 常量名使用全大写的下划线命名法,如MAX_SIZE。
2. 缩进和空格:- 使用4个空格进行缩进,不要使用Tab键。
- 运算符之间加空格,如 a + b。
- 逗号之后加空格,如int a, int b。
- 括号之间加空格,如if (condition)。
- 方法和类的左括号不另起一行。
3. 注释规范:- 使用Javadoc格式进行注释,包括类、方法和成员变量的说明。
- 每个方法需说明参数、返回值和可能抛出的异常。
- 不要保留没有用的注释。
- 注释应该与代码保持一致,不要误导阅读者。
4. 类和方法的设计:- 类应该具有单一的职责,不要包含无关的功能。
- 方法应该具有清晰的目的和语义,不要过长或过于复杂。
- 类和方法应该尽量避免过多的参数,如果参数过多,可以考虑使用封装对象。
5. 异常处理:- 对于可能抛出的异常,应该根据情况进行合理的处理,而不是简单地忽略或抛出异常。
- 使用try-catch语句来捕获并处理异常,避免在代码中出现不受控制的异常。
6. 代码重构:- 定期进行代码重构,提高代码的可读性和可维护性。
- 删除无用的代码和注释。
- 提取公共代码块,避免重复的代码。
7. 包名和导入:- 包名应该以小写字母开头,使用有意义的命名。
- 导入语句应该只导入使用到的类,不要使用通配符导入。
8. 代码格式化:- 使用自动代码格式化工具来保持代码的一致性,如Eclipse 的代码格式化功能。
9. 单元测试:- 编写单元测试来验证代码的正确性和可靠性。
Java代码格式规范个人推荐(带范例)个人整理Java编码格式规范,也是本人在开发中遵守的规范。
代码格式规范,仅是为了体现一种规范和美观,大家可根据各自情况和公司要求遵守自己的规范。
个人整理Java编码格式规范,也是本人在开发中遵守的规范。
代码格式规范,仅是为了体现一种规范和美观,大家可根据各自情况和公司要求遵守自己的规范。
1./**2. * Java编码格式个人推荐,参考JDK源码和Hyperic HQ源码(原spring旗下著名开源软件,现vmware)。
3. * @author lihzh(苦逼coder)4.* 本文地址:/3970029/7371205. */6.public class CodeRule {7.8.//声明变量,等号两边有空格。
9.private static int i = 1;10.11.//方法声明,右括号和左大括号中间有空格。
12.public static void main(String[] args) {13.//if语句,比较连接符(>)左右有空格,小括号和大括号中间有空格。
14.//if 与左括号中间有空格15.if (i > 0) {16. System.out.println(i);17. }18.//两个条件的连接(&&),左右有空格。
19.if (i > 0 && i < 2) {20. System.out.println(i);21. }22.23.//if..else 语句两种格式24.//1.参考JDK,个人使用方式,else跟大括号,前后都有空格25.if (i > 0 && i < 2) {26. System.out.println(i);27. } else if (i > 2) {28. System.out.println(i + 1);29. } else {30. System.out.println(i);31. }32.//2.参考Hyperic HQ源码, else另起一行,后仍有空格34. System.out.println(i);35. }36.else {37. System.out.println(i);38. }39.40.//while语句,与if语句类型,while与括号中间有空格,括号内格式与if相同41.while (i > 0 && i < 2) {42. System.out.println(i);43. i++;44. }45.46.//for语句,两种格式47.//1.参考Hyperic HQ,个人使用方式。
java代码开发规范⼀编码规范1.1 命名规范1. 代码中的命名均不能以特殊字符(如下划线、$#符号)开始或结束。
反例: _name / #Object2. 代码中的命名严禁使⽤拼⾳与英⽂混合的⽅式,更不允许直接使⽤中⽂的⽅式。
反例: toubao / lipei。
3. 类名使⽤UpperCamelCase风格,必须遵从驼峰形式。
正例:CommonUtils / BaseVo4. ⽅法名、参数名、成员变量、局部变量都统⼀使⽤lowerCamelCase风格,必须遵从驼峰形式。
正例: orderService / getOrderService()5. 常量命名全部⼤写,单词间⽤下划线隔开,⼒求语义表达完整清楚,不要嫌名字长。
正例: ZK_CONFIG_ROOTNODE6. 抽象类命名使⽤Abstract或Base开头;异常类命名使⽤Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。
7. 包名使⽤com.hetai.服务名.分层名。
正例: oauth系统的DAO, com.hetai.oauth.dao8. 如果使⽤到了设计模式或具有明确职责,建议在类名中体现出具体模式或职责。
正例:ExecutorFactory / AbstractProducer9. 各分层都需要接⼝和实现类,实现类⽤Impl作后缀与接⼝区别。
正例:OrderServiceImpl实现OrderService接⼝。
10. 枚举类名建议带上Enum后缀,枚举成员名称需要全⼤写,单词间⽤下划线隔开。
正例:枚举名字:PolicyIdTypeEnum,成员名称:ID_CARD/ PASSPORT。
11. 各层⽅法命名规范: 1)查询的⽅法⽤get/ query做前缀。
2)插⼊的⽅法⽤add 或insert做前缀。
3)删除的⽅法⽤remove 或delete做前缀。
4)修改的⽅法⽤modify/ update做前缀。
Info DMS
java代码开发模板
作者:周清江
发布日期:2007-11-23
当前版本:0.1
上海英孚思为信息科技有限公司
修订历史纪录
代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订 Info DMS
英孚思为机密文件 Java 开发模板文件导入
1. 导入统一的版权信息和类、方法、字段注释格式文件
第一步 打开 Preference,选中
code_style->>Code_Templates
第二步选择Import …
文件名:code_style_templates.xml
代码开发环境修订 Info DMS
英孚思为机密文件
2. 导入统一代码样式文件
第一步 打开 Preference,选中code_style->>Fromatter
代码开发环境修订 Info DMS
英孚思为机密文件
第二步选择Import … 文件名:
code_style_formatter.xml
File Descript统一定义
导入统一的版权信息以后当新建每个JA V A以后,JA V A文件头内容统一为:/**
*Copyright(c)2006-2008OEM Infoservice Corp.2006-2008,All Rights Reserved.
*This software is published under the Infoservice DMS Service Inner Solution Team.
*License version 1.0,a copy of which has been included with this *distribution in the LICENSE.txt file.
*
*@File name:
base.actions.MaintainBrand.java
*@Create on:2007-9-30
*@Author:kevin
*
*@ChangeList
*---------------------------------------------------
*NO Date Editor ChangeReasons
* 1.2007-9-30kevin Add
*
*/
注意:
1.如果文件不是新建而是从原来的项目中拷贝过来,请修改包名
和类名.(@File name:)
base.actions.MaintainBrand.java
2.如果因为重要的业务逻辑而修改过文件,不要忘了在(@ChangeList)加上相关修改日期、修改人和简单描述修改原因。
Class Body( Action) 描述内容
在一些业务比较简单的Action文件中Class Body内容没有设置,这样生成的JA V ADOC文档中这些Action就很难读懂。
对于业务相对简单的Action也需对该业务内容做简单的描述,如下:
代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订 Info DMS
英孚思为机密文件
注意:
1. 由于文件新建时不会自动产生上面的注释代码,此时可以输入“/**”加上回车就会出现注释模板,再在业务描述中描述此方法的功能。
2. 如果方法内有复杂的业务逻辑,要多用 “//取得新增、修改状态参数”这样的注释,以增强代码的可读性。
3.些注释同样应用于所有METHOD (除PO 类),如FOFACTORY 方法和COMMON 下的一些工具类方法。
字段的描述
对于一些有特定业务说明的字段要加以注释,比如常量类的,数据字典还有状态等。
异常的处理
1.
CVS提交Comment内容填写
在进行代码提交时,对要提交的代码进行简要的描述;描述当前提交的代码与仓库中的代码区别及修改理由。
代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订Info DMS 英孚思为机密文件。