java的包类方法变量命名规范
java中的命名规则和具体要求
![java中的命名规则和具体要求](https://img.taocdn.com/s3/m/37322ee985254b35eefdc8d376eeaeaad1f31625.png)
java中的命名规则和具体要求
在Java中,命名规则和具体要求有以下几点:
1. 标识符的命名规则:
- 可以由字母、数字、下划线和美元符号组成。
- 第一个字符必须是字母、下划线或美元符号。
- 标识符不能是Java的关键字,例如if、for、class等。
2. 标识符的命名规范:
- 使用驼峰命名法(Camel Case):除了第一个单词的首字母小写外,其余单词的首字母大写。
- 标识符要有意义,能够清晰地表达其用途。
- 标识符不宜过长,一般不超过15个字符。
3. 包名的命名规范:
- 同样使用驼峰命名法。
- 包名应该是全小写字母。
- 包名应该与域名反向相对应,例如com.example。
4. 类名的命名规范:
- 使用驼峰命名法。
- 类名的第一个字母应该大写。
- 类名应该是名词或名词短语。
5. 方法名的命名规范:
- 使用驼峰命名法。
- 方法名的第一个字母应该小写。
- 方法名应该是动词或动词短语。
6. 常量名的命名规范:
- 使用全大写字母。
- 多个单词之间用下划线分隔。
- 常量名应该是名词或名词短语。
需要注意的是,虽然Java中对变量名的长度没有明确限制,但为了提高代码的可读性,应尽量避免使用过长的变量名。
另外,根据Java编码规范,建议使用英文命名,不要使用中文或其他非英文字符。
Java编程规范总结
![Java编程规范总结](https://img.taocdn.com/s3/m/ae712fcb6e1aff00bed5b9f3f90f76c661374c22.png)
Java编程规范总结命名:1. 为包、类、⽅法、变量取⼀个好名字,使代码易于理解2. 禁⽌使⽤魔⿁数字3. 常量命名,由全⼤写单词组成,单词间⽤下划线分隔,且使⽤ static final修饰4. 变量、属性命名,使⽤名词,并采⽤⾸字母⼩写的驼峰命名法5. ⽅法的命名,⽤动词和动宾结构,并采⽤⾸字母⼩写的驼峰命名法6. 类和接⼝的命名,采⽤⾸字母⼤写的驼峰命名法7. 包的命名,由⼀个或若⼲个单词组成,所有的字母均为⼩写8. 数组声明的时候使⽤ int[] index,⽽不要使⽤ int index[]注释:1. 尽量⽤代码来解释⾃⼰2. 注释应解释代码的意图,⽽不是描述代码怎么做的3. 保证注释与代码⼀致,避免产⽣误导4. 注释应与其描述代码位置相邻,放在所注释代码上⽅或右⽅,并与代码采⽤同样缩进5. 不要⽤注释保留废弃代码6. 不要⽤注释记录修改⽇志7. ⼀般单⾏注释⽤//,块注释⽤,JavaDoc注释⽤排版:1. 团队应遵守⼀致的排版风格2. 将排版风格固化到IDE的代码格式化配置⽂件中,并让整个团队使⽤3. 在不同的概念之间,增加空⾏4. 将逻辑紧密相关的代码放在⼀起5. 控制⼀⾏的宽度,不要超过120个字符6. 在不同的概念间(关键字、变量、操作符等)增加空格,以便清楚区分概念7. 采⽤缩进来区分不同层次的概念8. 将局部变量的作⽤域最⼩化9. 给if、for、do、while、switch等语句的执⾏体加⼤括号{}10. 控制⽂件的长度,最好不要超过500⾏变量和类型:1. 谨慎使⽤静态成员变量2. 避免随意进⾏类型强制转换,应改善设计,或在转换前⽤instanceof进⾏判断33. 需要精确计算时不要使⽤float和double4. 不能⽤浮点数作为循环变量5. 浮点型数据判断相等不能直接使⽤==6. 避免同⼀个局部变量在前后表达不同的含义7. 不要在单个的表达式中对相同的变量赋值超过⼀次8. 基本类型优于包装类型,注意合理使⽤包装类型⽅法:1. ⽅法设计的第⼀原则是要短⼩2. ⽅法设计应遵循单⼀职责原则(SRP),⼀个⽅法仅完成⼀个功能3. ⽅法设计应遵循单⼀抽象层次原则(SLAP)4. ⽅法设计应遵循命令与查询职责分离原则(CQRS)5. 不要把⽅法的⼊参当做⼯作变量/临时变量,除⾮特别需要6. 使⽤类名调⽤静态⽅法,⽽不要使⽤实例或表达式来调⽤7. 应明确规定对接⼝⽅法参数的合法性检查由调⽤者负责还是由接⼝⽅法本⾝负责8. ⽅法的参数个数不宜过多9. 谨慎使⽤可变数量参数的⽅法包、类和接⼝:1. 类和接⼝的设计应遵循⾯向对象SOLID设计原则2. 类的设计应遵循迪⽶特法则3. 类的设计应遵循“Tell,Don't ask”原则4. 类设计时优选组合⽽不是继承5. 除提供给外部使⽤的全局常量外,应尽量避免类成员变量被外部直接访问6. 避免在⽆关的变量或⽆关的概念之间重⽤名字,避免隐藏(hide)、遮蔽(shadow)和遮掩(obscure)7. 覆写(override)——⼦类与⽗类间8. 重载(overload)——类内部9. 隐藏(hide)——⼦类与⽗类间10. 遮蔽(shadow)——类内部11. 遮掩(obscure)——类内部12. 不要在⽗类的构造⽅法中调⽤可能被⼦类覆写的⽅法13. 覆写equals⽅法时,应同时覆写hashCode⽅法14. ⼦类覆写⽗类⽅法时应加上@Override注解15. 接⼝定义中去掉多余的修饰词16. 设计时,考虑类的可变性最⼩化异常:1. 只针对真正异常的情况才使⽤exception机制2. 在抛出异常的细节信息中,应包含能捕获失败的信息3. 对可恢复的情况使⽤受检异常(checked exception),对编程错误使⽤运⾏时异常(runtime exception)4. 不要忽略异常5. ⽅法注释和⽂档中要包含所抛出异常的说明6. ⽅法抛出的异常,应该与本⾝的抽象层次相对应7. 对第三⽅API抛出⼤量各类异常进⾏封装8. 使⽤异常来做错误处理,⽽⾮错误码9. 在finally块中不要使⽤return、break或continue使finally块⾮正常结束10. 不要直接捕获受检异常的基类Exception11. ⼀个⽅法不应抛出太多类型的异常12. 充分利⽤断⾔⽇志:1. ⽇志信息准确、繁简得当,满⾜快速定位的需要2. ⽇志的记录,不要使⽤ System.out 与 System.err 进⾏控制台打印,应该使⽤专⽤的⽇志⼯具(⽐如:slf4j+logback)进⾏处理3. ⽇志⼯具对象logger应声明为private static final4. ⽇志应分等级5. ⽇志中不要记录敏感信息多线程并发:1. 多线程访问同⼀个可变变量,需增加同步机制2. 禁⽌不加控制地创建新线程3. 创建新线程时需指定线程名4. 使⽤Thread对象的setUncaughtExceptionHandler⽅法注册Runtime异常的处理者(v1.5+)5. 不要使⽤Thread.stop⽅法,因为该⽅法本质是不安全的,使⽤它可能会导致数据遭到破坏6. 不要依赖线程调度器、线程优先级和yield()⽅法7. 采⽤Java1.5提供新并发⼯具代替wait和notify(v1.5+)8. 使⽤线程安全集合在多线程间共享可变数据9. 多线程操作同⼀个字符串相加,应采⽤StringBuffer10. 针对线程安全性,需要进⾏⽂档(javadoc)说明运算和表达式:1. 不要写复杂的表达式2. 运算时应避免产⽣溢出3. 采⽤括号明确运算的优先级控制语句:1. 采⽤for-each代替传统的for循环(v1.5+)2. 在switch语句的每⼀个case、和default中都放置⼀条break语句序列化:1. 尽量不要实现Serializable接⼝2. 序列化对象中的HashMap、HashSet或HashTable等集合不能包含对象⾃⾝的引⽤3. 实现Serializable接⼝的可序列化类应该显式声明 serialVersionUID泛型:1. 在集合中使⽤泛型(v1.5+)2. 类的设计可优先考虑泛型(v1.5+)3. ⽅法的设计可优先考虑泛型(v1.5+)4. 优先使⽤泛型集合,⽽不是数组(v1.5+)其他语⾔特性:1. 新代码不要使⽤已标注为@deprecated的⽅法2. 使⽤JDK⾃带的API或⼴泛使⽤的开源库,不要⾃⼰写类似的功能。
java 开发规范
![java 开发规范](https://img.taocdn.com/s3/m/2955b52553ea551810a6f524ccbff121dd36c526.png)
java开发规范(一)java命名规范1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义例子:变量——用户数据(userList)、方法——getUserData(int type)等。
说明:正常变量定义使用驼峰命名,特殊的如DTO\VO\DO等除外。
2、类名的定义(1)普通类名采用大写字母开始;(2)抽象类采用Abstract或Base开头。
例子:普通类——class UserModel,抽象类——abstract class AbstractUserDefinition等。
3、常量、类型、接口、子类的定义(1)常量使用全大写且单词之间用"_“隔开; (2)boolean变量不能使用is开头;(3)接口尽量不要修饰符、子类紧跟接口追加Impl。
例子:常量——SORT_TYPE,布尔类型——flag,接口——UserService,实现类——UserServiceImpl等。
说明:常量不可组装,需要原子性定义,不能出现"KEY”+SORT_TYPE 这种内部出现。
4、包名、异常、枚举、方法名称的定义(1)包名一律采用小写; (2)异常都采用_Exception结尾; (3)枚举都是以Enum结尾;(4)方法名称——根据方法内容采用如插入insert-*。
例子:异常——UserException,包名——com.test,枚举——UserEnum,方法名称——insertUser等。
5、领域模型定义规范:主要是以VO\DTO\DO等结尾例子:用户数据——UserDTO等(1)数据对象:xxxDO,xxx 即为数据表名。
(2)数据传输对象:xxxDTO,xxx为业务领域相关的名称。
(3)展示对象:xxxVO,xxx一般为网页名称。
(4)POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。
(二)代码格式规范1、括号代码要求左大括号前不换行、左大括号后换行、右大括号前换行、右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
java中项目包类命名规则
![java中项目包类命名规则](https://img.taocdn.com/s3/m/e64c9127dcccda38376baf1ffc4ffe473368fde6.png)
java中项目包类命名规则摘要:1.项目包命名规则的重要性2.Java项目包命名规则的具体规定3.命名规则在实际项目中的应用4.违反命名规则可能带来的问题5.总结:遵循命名规则,提高项目可读性和维护性正文:在Java开发中,项目包命名规则是保证代码可读性和维护性的重要环节。
合理的包命名可以帮助开发者快速理解代码功能,降低沟通成本,提高开发效率。
本文将详细介绍Java项目包命名规则的具体规定,以及在实际项目中如何应用这些规则。
一、项目包命名规则的重要性项目包命名规则是Java项目组织结构的基础,它有助于将相关功能划分为一个有机的整体。
合理的包命名可以帮助开发者快速定位到所需的功能模块,降低查找和理解代码的成本。
此外,良好的命名规则还能提高代码的可维护性,使得团队成员更容易协作,共同完成项目开发。
二、Java项目包命名规则的具体规定1.包名应具备可读性:包名应能够清晰地表达出该包所包含的功能模块。
可以使用驼峰命名法(CamelCase)或者下划线命名法(Underline)来命名包,使其更具可读性。
2.包名应简洁明了:尽量避免使用过长的包名,以免影响代码的可读性。
一般来说,包名的长度不超过2-3个单词较为合适。
3.包名应遵循命名规范:Java项目包命名应遵循以下规范:- 首字母大写:包名第一个单词的首字母应大写。
- 单词间用下划线分隔:包名中的单词之间使用下划线分隔,以提高可读性。
- 避免使用特殊字符:包名中不应包含特殊字符,如连字符、字母数字以外的字符等。
4.包名应保持一致:在整个项目中,相同功能的模块应使用相同的包名。
这样可以提高代码的一致性,降低维护成本。
三、命名规则在实际项目中的应用在实际项目中,命名规则可以帮助开发者更好地组织代码,提高代码的可读性和可维护性。
以下是一个实际项目中的包命名示例:- com.example.project(项目根目录)- com.example.project.controller(控制器包)- er(用户控制器包)- er.login(用户登录控制器)- er.register(用户注册控制器)- com.example.project.service(服务包)- er(用户服务包)- er.impl(用户服务实现包)- com.example.project.model(模型包)- er(用户模型包)- er.entity(用户实体类包)- er.vo(用户视图对象包)- com.example.project.util(工具包)四、违反命名规则可能带来的问题1.代码可读性降低:不合理的名词拼写、过长的包名等都会影响代码的可读性,增加理解难度。
java命名规范
![java命名规范](https://img.taocdn.com/s3/m/9a263a08f011f18583d049649b6648d7c1c7088f.png)
java命名规范Java命名规范是指在编写Java代码时应遵循的命名规则和约定。
它的目的是为了使代码更易于阅读、理解和维护。
下面是关于Java命名规范的详细说明:1. 包名:- 包名应该全部小写,不使用下划线或其他特殊字符。
- 包名应该按照域名倒序指定,例如com.example.project。
- 包名应该具有实际意义,反映所包含的类的功能。
2. 类名:- 类名以大写字母开头,并使用驼峰式命名法,例如MyClass。
- 类名应该具有实际意义,反映类的责任和功能。
- 类名不应该使用缩写或首字母缩写。
3. 接口名:- 接口名以大写字母开头,并使用驼峰式命名法,例如MyInterface。
- 接口名应该具有实际意义,反映接口的功能。
4. 方法名:- 方法名以小写字母开头,并使用驼峰式命名法,例如myMethod。
- 方法名应该具有实际意义,反映方法的功能。
- 方法名不应该使用缩写或首字母缩写。
5. 变量名:- 变量名以小写字母开头,并使用驼峰式命名法,例如myVariable。
- 变量名应该具有实际意义,反映变量的用途。
- 如果变量名包含多个单词,则使用下划线将其分隔,例如my_variable。
6. 常量名:- 常量名应该全部大写,并使用下划线将单词分隔,例如MY_CONSTANT。
- 常量名应该具有实际意义,反映常量的用途。
7. 枚举类型名:- 枚举类型名以大写字母开头,并使用驼峰式命名法,例如MyEnum。
8. 包内私有变量和方法名:- 包内私有变量和方法名以小写字母开头,并使用驼峰式命名法,例如myPrivateVariable。
- 包内私有变量和方法应该具有实际意义,反映其用途和功能。
9. 类成员变量和方法名:- 类成员变量和方法名以小写字母开头,并使用驼峰式命名法,例如myMemberVariable。
- 类成员变量和方法名应该具有实际意义,反映其用途和功能。
10. 参数名:- 参数名以小写字母开头,并使用驼峰式命名法,例如myParameter。
java 编程规范
![java 编程规范](https://img.taocdn.com/s3/m/d57c7f0a66ec102de2bd960590c69ec3d5bbdb0e.png)
java 编程规范Java编程规范是为了促进Java代码的可读性、可维护性和可扩展性而制定的标准。
以下是一些常见的Java编程规范:一、命名规范1. 类名、接口名、枚举名首字母大写,采用驼峰命名法。
2. 变量名、方法名首字母小写,采用驼峰命名法。
3. 常量名全部大写,使用下划线分割单词。
4. 包名全部小写,使用点号分割单词。
二、代码格式1. 使用4个空格缩进。
2. 每行代码长度不超过80个字符。
3. 在二元运算符(如赋值、算术运算、逻辑运算)两侧添加空格。
4. 在逗号、冒号、分号之后添加空格。
5. 在左花括号之后和右花括号之前添加空格。
6. 在注释之前添加空格。
三、代码结构1. 类的成员按照作用域排列,先是静态成员,然后是实例成员。
2. 类的方法按照功能排列,先是构造方法,然后是其他方法。
3. 每个类只负责一个功能,遵循单一职责原则。
4. 使用适当的访问修饰符控制成员变量和方法的访问级别。
四、异常处理1. 不要捕获异常而不做任何处理,应该记录日志或者抛出更高级别的异常。
2. 不要将整个方法体放在try-catch块中,应该只捕获需要处理的异常。
3. 不要使用异常控制程序的流程,应该使用条件语句或者循环结构。
五、注释规范1. 使用Javadoc注释对类、方法、参数、返回值进行说明。
2. 在每个类的头部使用Javadoc注释描述该类的功能。
3. 使用内联注释对代码进行解释、补充和说明。
4. 注释应该清楚、简明、不冗余,遵循自然语言的习惯。
六、其他规范1. 避免使用魔法数值,应该使用常量或者枚举来表示。
2. 使用块注释对重要的代码块进行标注,方便阅读和查找。
3. 使用业界公认的缩写和术语,避免拼写错误和歧义。
4. 使用合适的数据结构和算法来解决问题,避免低效的代码。
以上仅是Java编程规范的一部分,具体的规范还需要根据具体的项目和团队来制定。
遵循编程规范可以提高代码质量和可维护性,提升团队的协作效率。
java 包名命名规则
![java 包名命名规则](https://img.taocdn.com/s3/m/04b38831bfd5b9f3f90f76c66137ee06eff94e8b.png)
java 包名命名规则Java包名命名规则Java是一种面向对象的编程语言,它的包名命名规则是非常重要的。
包名是Java中组织类的一种方式,它可以将相关的类组织在一起,方便管理和使用。
在Java中,包名的命名规则是非常严格的,下面我们来详细了解一下。
1. 包名的命名规则Java中的包名是由多个单词组成的,每个单词之间用“.”分隔。
包名的第一个单词是公司或组织的域名,后面的单词是项目或模块的名称。
例如,com.example.project。
包名中的每个单词都应该是小写字母,不要使用大写字母或下划线。
如果包名中包含多个单词,可以使用驼峰命名法,例如,com.example.myProject。
2. 包名的含义包名的含义应该与包中的类的功能相关。
例如,com.example.project.dao包中的类应该是数据访问对象,com.example.project.service包中的类应该是业务逻辑处理对象。
包名应该是有意义的,能够清晰地表达包中类的功能。
不要使用无意义的包名,例如,com.example.project.utils。
3. 包名的长度包名的长度应该控制在合理的范围内,不要过长。
包名的长度应该在3到7个单词之间,不要超过10个单词。
包名过长会影响代码的可读性和可维护性,不利于代码的管理和使用。
4. 包名的命名规范包名的命名规范应该遵循Java的命名规范。
包名应该以小写字母开头,不要使用数字或特殊字符。
包名应该是有意义的,能够清晰地表达包中类的功能。
包名应该使用英文单词,不要使用中文或其他语言的单词。
包名应该使用单数形式,不要使用复数形式。
5. 包名的重要性包名是Java中组织类的一种方式,它可以将相关的类组织在一起,方便管理和使用。
包名的命名规则是非常重要的,它能够影响代码的可读性、可维护性和可重用性。
包名应该是有意义的,能够清晰地表达包中类的功能。
包名应该控制在合理的长度范围内,不要过长。
java变量名命名规则
![java变量名命名规则](https://img.taocdn.com/s3/m/788625376ad97f192279168884868762caaebbed.png)
java变量名命名规则Java变量名命名规则是Java编程的一项基本技能,它涉及到变量的使用、存储、定义和声明。
为了让程序更容易理解,避免出现程序错误,有效地组织程序代码,Java的变量名命名规则就显得尤为重要。
1. 命名规范变量名必须以字母(A-Z或a-z)、下划线(_)或美元符号($)开头,后面可以跟字母、下划线或数字(0-9)。
变量名不能包含关键字和保留字,变量名中不能有空格,例如:age_of_student、$name 等。
2. 命名方法(1)驼峰式命名:把一个名字由多个单词组成时,每个单词的首字母大写,其余字母小写,第一个单词的首字母可以大写也可以小写,例如:ageOfStudent、NameOfStudent 等。
(2)下划线命名:把一个名字由多个单词组成时,每个单词之间用下划线连接,所有单词都用小写字母,例如:age_of_student、name_of_student 等。
(3)常量命名:当变量是常量时,把变量名全部用大写字母表示,每个单词之间用下划线连接,例如:AGE_OF_STUDENT、NAME_OF_STUDENT 等。
3. 命名规范(1)变量名应该具有描述性,能够从字面上看出它的含义,例如:ageOfStudent 或 nameOfStudent 等;(2)变量名应该尽量简短,但又要保持描述性;(3)变量名应该具有区分度,不能与类中原有的变量名重复;(4)变量名应该使用英文,因为Java是基于英文语言构建的;(5)变量名不能和Java中的关键字相同;(6)变量名不能以数字开头;(7)变量名不能包含空格;(8)变量名不能包含特殊字符,例如:@、#、%、&等。
以上就是Java变量名命名规则的详细说明,在使用Java变量名时要牢记以上规则,以便正确地命名变量,使程序更容易理解,避免出现程序错误,有效地组织程序代码。
java中包名命名规则
![java中包名命名规则](https://img.taocdn.com/s3/m/efb30b12443610661ed9ad51f01dc281e53a569c.png)
Java中包名命名规则1. 概述在Java中,包名是一种用于组织和管理类文件的方式。
通过将相关的类文件组织在同一个包下,可以方便地进行分类和查找。
合理的包名命名规则有助于提高代码的可维护性和可读性。
本文将介绍Java中包名的命名规则,包括命名规范、常用命名约定和最佳实践。
2. 命名规范Java中的包名是由小写字母、数字和下划线组成的。
包名的命名规范如下:•包名可以包含多个单词,使用小写字母和数字的组合。
•包名应该具有较为明确的名称,能够准确地反映包中所包含的类的功能。
•包名应该使用小写字母,不推荐使用大写字母。
•包名的长度应该控制在合理范围内,通常不要超过单词个数为5个。
以下是一些示例合法的包名:•com.example.project:表示com公司的example项目。
•org.mycompany.myproject:表示org组织的myproject项目。
•com.example.myproject.utils:表示com公司的myproject项目中的工具类。
3. 常用命名约定为了方便理解和阅读代码,有些情况下我们可以使用一些常用的命名约定。
虽然这些约定并不是强制要求的,但是在实际开发中广泛使用。
以下是一些常用的命名约定:•使用域名反转的方式命名包名,如com.example.project。
•使用公司或组织的名称作为包名的前缀,如org.mycompany.myproject。
•使用项目或模块名称作为包名的一部分,如com.example.myproject.utils。
•使用带有特定语义的单词作为包名的一部分,如com.example.myproject.api。
•避免使用Java关键字作为包名,避免与Java标准库中的类名冲突。
4. 最佳实践除了符合命名规范和常用命名约定外,还有一些最佳实践可以帮助我们更好地组织和管理包名。
4.1 适当的层级结构包名应该具有适当的层级结构,以便更好地组织和管理类文件。
java 代码规范
![java 代码规范](https://img.taocdn.com/s3/m/9fb9af4e02d8ce2f0066f5335a8102d276a2612d.png)
java 代码规范Java代码规范是指在Java程序设计中遵循的一些规则和约定,旨在提高代码的可读性、可维护性和可移植性。
遵守代码规范可以帮助团队成员更好地理解和协作开发,提高代码的质量和可靠性。
本文将围绕Java代码规范展开讨论,包括命名规范、代码风格、注释规范、异常处理等方面的内容。
一、命名规范1.包名规范包名应该全小写,连接符可以使用小写字母和下划线,不推荐使用数字。
包名应该能够清晰地表达包所包含的内容,不要使用太长或者太短的包名。
2.类名规范类名应该采用驼峰命名法,首字母大写,类名应该能够清晰地表达类的用途,不要使用太长或者太短的类名。
如果类名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
3.接口名规范接口名应该采用驼峰命名法,首字母大写,接口名应该能够清晰地表达接口的用途,不要使用太长或者太短的接口名。
如果接口名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
4.变量名规范变量名应该采用驼峰命名法,首字母小写,变量名应该能够清晰地表达变量的用途,不要使用太长或者太短的变量名。
如果变量名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
5.常量名规范常量名应该全大写,单词之间使用下划线分隔,常量名应该能够清晰地表达常量的用途,不要使用太长或者太短的常量名。
6.方法名规范方法名应该采用驼峰命名法,首字母小写,方法名应该能够清晰地表达方法的用途,不要使用太长或者太短的方法名。
如果方法名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
二、代码风格1.缩进和空格缩进使用4个空格,不使用tab键。
在操作符前后使用空格,增强代码的可读性。
2.大括号的使用在类定义、方法定义、控制结构等的语句块后面使用大括号,增强代码的可读性。
3.代码行长度每行代码的长度不要超过80个字符,超过80个字符的代码应该使用换行符进行分割。
4.引号的使用字符串常量应该使用双引号,字符常量应该使用单引号。
Java命名规范(非常全面)
![Java命名规范(非常全面)](https://img.taocdn.com/s3/m/894013c027fff705cc1755270722192e45365822.png)
Java命名规范(⾮常全⾯)⽬录1.包命名规范2.类命名规范2.1接⼝命名规范2.2抽象类命名规范2.3异常类命名规范3.⽅法命名规范3.1表述获取3.2表述查询3.3表述条件3.4表述设置3.5其他规范4.变量命名规范5.常量命名规范6.枚举命名规范7.其他命名规范7.1数组7.2表述复数或者集合7.3泛型类7.4接⼝实现类7.5测试类和测试⽅法8扩展:速记Java开发中的各种O前⾔:最近发现很多初级程序员写代码时很不规范,⽐如⽅法名类名等,如果遇到有代码洁癖的领导肯定会被骂(什么垃圾代码),下⾯分享⼀篇不错的规范⽂章我将按照项⽬⼯程⽬录结构,从包,类(接⼝,抽象类,异常类),⽅法,变量和常量的顺序展开介绍。
本⽂是 Java 命名规范的介绍,建议收藏转发。
1. 包命名规范包(Package)的作⽤是将功能相似或相关的类或者接⼝进⾏分组管理,便于类的定位和查找,同时也可以使⽤包来避免类名的冲突和访问控制,使代码更容易维护。
通常,包命使⽤⼩写英⽂字母进⾏命名,并使⽤“.”进⾏分割,每个被分割的单元只能包含⼀个名词。
⼀般地,包命名常采⽤顶级域名作为前缀,例如com,net,org,edu,gov,cn,io等,随后紧跟公司/组织/个⼈名称以及功能模块名称。
下⾯是⼀些包命名⽰例:package org.springframework.boot.autoconfigure.cloudpackage org.springframework.boot.utilpackage org.hibernate.actionpackage org.hibernate.cfgpackage com.alibaba.druidpackage com.alibaba.druid.filterpackage com.alibaba.nacos.client.configpackage com.ramostear.blog.web下⾯是Oracle Java的⼀些常见包命名例⼦:package java.beanspackage java.iopackage ngpackage package java.utilpackage javax.annotation2. 类命名规范类(Class)通常采⽤名词进⾏命名,且⾸字母⼤写,如果⼀个类名包含两个以上名词,建议使⽤驼峰命名(Camel-Case)法书写类名,每个名词⾸字母也应该⼤写。
java驼峰原则
![java驼峰原则](https://img.taocdn.com/s3/m/76739eab534de518964bcf84b9d528ea81c72fa2.png)
java驼峰原则Java驼峰原则是一种命名规范,用于定义Java编程语言中的变量、方法和类的命名方式。
该原则的名称来源于其命名风格,其中每个单词的首字母大写,但第一个单词的首字母小写。
以下是Java驼峰原则的相关参考内容。
1. 变量命名在Java中,变量的命名应遵循驼峰原则。
变量名应该由一个或多个单词组成,每个单词的首字母小写,而后续单词的首字母大写。
例如,一个表示学生年龄的变量可以命名为"studentAge"。
2. 方法命名Java中的方法命名也应遵循驼峰原则。
方法名应该以一个动词开头,后面跟着一个或多个名词或形容词。
每个单词的首字母大写,而后续单词的首字母小写。
例如,一个计算两个数字和的方法可以命名为"calculateSum"。
3. 类命名Java中的类命名也应遵循驼峰原则。
类名应该以一个名词开头,后面跟着一个或多个名词或形容词。
每个单词的首字母大写,而后续单词的首字母小写。
例如,一个表示学生信息的类可以命名为"StudentInfo"。
4. 包命名在Java中,包的命名也应遵循驼峰原则。
包名应该由一个或多个单词组成,每个单词的首字母小写,而后续单词的首字母大写。
例如,一个表示工具类的包可以命名为"utils"。
5. 常量命名Java中的常量命名应该使用全大写字母,并使用下划线分隔单词。
例如,一个表示圆周率的常量可以命名为"PI"。
6. 构造函数命名Java中的构造函数命名应该遵循驼峰原则,与类命名相同。
例如,一个表示学生信息的类的构造函数可以命名为"StudentInfo"。
7. 接口命名在Java中,接口命名应遵循驼峰原则。
接口名应该与类名相似,以一个名词开头,每个单词的首字母大写,而后续单词的首字母小写。
例如,一个表示文件操作的接口可以命名为"FileOperation"。
java的命名规范
![java的命名规范](https://img.taocdn.com/s3/m/1ccd2c3d02d8ce2f0066f5335a8102d276a261d2.png)
java的命名规范Java的命名规范是一种编码规范,它定义了在Java程序中如何命名变量、方法、类等标识符的规则和准则。
遵循这些规范可以使代码更加易读、易懂和易于维护。
以下是关于Java命名规范的一些指导原则和建议。
1. 包名:包名必须以小写字母开头,且只能包含小写字母、数字和下划线(_),不能以数字开头。
2. 类名:类名必须以大写字母开头,并采用驼峰命名法,即将每个单词首字母大写,其余字母小写。
3. 接口名:接口名与类名相似,也要采用驼峰命名法。
4. 方法名:方法名必须以小写字母开头,并采用驼峰命名法。
5. 变量名:变量名必须以小写字母开头,并采用驼峰命名法。
6. 常量名:常量名应全大写,并用下划线分隔单词。
7. 数组名:数组名要有意义,并采用驼峰命名法。
8. 枚举类型名:枚举类型名要以大写字母开头,并采用驼峰命名法。
9. 枚举常量名:枚举常量名要全大写,多个单词间用下划线分隔。
10. 参数名:参数名应该具有描述性,采用驼峰命名法。
11. 局部变量名:局部变量名应该具有描述性,并采用驼峰命名法。
12. 泛型类型参数名:泛型类型参数名通常使用单个大写字母。
13. 缩写词:对于缩写词,应该采用一致的规则,例如URL、HTTP或XML。
14. 不要使用保留字:不要使用Java的关键字作为标识符。
15. 避免使用单个字符作为名称:使用具有描述性的名称可以使代码更易于阅读和理解。
16. 避免使用下划线作为名称的开头或结尾:这样的命名风格通常用于特殊情况,例如私有变量或常量。
17. 命名要有意义和可读性:命名应该具有描述性,能够准确地反映出变量、方法或类的用途和功能。
18. 遵循团队内部统一的命名规范:在团队中应制定一致的命名规范,并严格遵循。
19. 使用驼峰命名法:驼峰命名法是一种常用的命名约定,可以提高代码的可读性。
20. 注释:对于特别复杂或不容易理解的代码,应添加注释来解释其用途和功能。
总之,Java的命名规范主要是为了提高代码的可读性、可维护性和一致性。
Java项目命名规范
![Java项目命名规范](https://img.taocdn.com/s3/m/623f09c45022aaea998f0fa2.png)
Java项目命名规范一、命名规范1、项目名全部小写2、包名全部小写3、类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:public class MyFirstClass{}4、变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
如:int index=0;public void toString(){}5、常量名全部大写如:public static final String GAME_COLOR=”RED”;6、所有命名规则必须遵循以下规则:1)、名称只能由字母、数字、下划线、$符号组成2)、不能以数字开头3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。
二、注释规范1、类注释在每个类前面必须加上类注释,注释模板如下:/*** Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.* FileName: Test.java* 类的详细说明** @author 类创建者姓名* @Date 创建日期* @version 1.00*/2、属性注释在每个属性前面必须加上属性注释,注释模板如下:/** 提示信息*/private String strMsg = null;3、方法注释在每个方法前面必须加上方法注释,注释模板如下:/*** 类方法的详细使用说明** @param 参数1 参数1的使用说明* @return 返回结果的说明* @throws 异常类型.错误代码注明从此类方法中抛出异常的说明*/4、构造方法注释在每个构造方法前面必须加上注释,注释模板如下:/*** 构造方法的详细使用说明** @param 参数1 参数1的使用说明* @throws 异常类型.错误代码注明从此类方法中抛出异常的说明*/5、方法内部注释在方法内部使用单行或者多行注释,该注释根据实际情况添加。
java代码开发规范
![java代码开发规范](https://img.taocdn.com/s3/m/ea7d4d2da31614791711cc7931b765ce05087ad3.png)
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包的命名规范
![Java包的命名规范](https://img.taocdn.com/s3/m/b47568c1db38376baf1ffc4ffe4733687e21fc72.png)
Java包的命名规范1,package必须是程序中可执⾏的第⼀⾏代码2,package语句只能有⼀句3,package命名要求包含的所有字符均为⼩写,同时不能有特殊字符4,package可以有多层,每⼀层有.隔开,例如:package china.hubei.wuhan;(China是⼀个⽂件夹,hubei是china下的⼀个⽂件夹,wuhan是hubei⽂件夹下的⼀个⽂件夹5,package语句后⾯的分号不要掉。
6,包的路径符合所开发的系统模块的定义,⽐如⽣产对⽣产,物资对物资,基础类对基础类。
7,如果定义类的时候没有使⽤package,那么java就认为我们所定义的类位于默认包⾥⾯(default package)。
indi :个体项⽬(individual),指个⼈发起,但⾮⾃⼰独⾃完成的项⽬,可公开或私有项⽬,copyright主要属于发起者。
包名为“indi.发起者名.项⽬名.模块名……”onem :单⼈项⽬(one-man),推荐⽤indi,指个⼈发起,但⾮⾃⼰独⾃完成的项⽬,可公开或私有项⽬,copyright主要属于发起者。
包名为“onem.发起者名.项⽬名.模块名……”pers :个⼈项⽬(personal),指个⼈发起,独⾃完成,可分享的项⽬,copyright主要属于个⼈。
包名为“pers.个⼈名.项⽬名.模块名.……”priv :私有项⽬(private),指个⼈发起,独⾃完成,⾮公开的私⼈使⽤的项⽬,copyright属于个⼈。
包名为“priv.个⼈名.项⽬名.模块名.……”team:团队项⽬,指由团队发起,并由该团队开发的项⽬,copyright属于该团队所有。
包名为“team.团队名.项⽬名.模块名.……”com :公司项⽬,copyright由项⽬发起的公司所有。
包名为“com.公司名.项⽬名.模块名.……”----------------------------------------------------------------------------------Java包的命名规则util:对应英⽂utility(实⽤⼯具),⼀般存放⼯具类,就像ng.util包⼀样存放着各种各样的⼯具类⽅便你编程,这⾥你可以放⾃⼰写好的⼯具类为⾃⼰的程序提供⽅便。
简述java变量的命名规则
![简述java变量的命名规则](https://img.taocdn.com/s3/m/85bff26fb207e87101f69e3143323968011cf498.png)
简述java变量的命名规则Java变量的命名规则是Java程序开发人员在编写Java程序时,需要遵守的规则。
它们是Java编程语言中使用变量的必要规则,是Java程序的基本要求。
在Java编程语言中,变量的命名将会是一个非常重要的议题。
一般来说,对于Java变量的命名规则有以下几条:(1)变量名必须以字母或者下划线开头;(2)变量名只能包含字母,数字和下划线;(3)变量名不能包含空格;(4)变量名不能包含特殊字符;(5)变量名不能以数字开头;(6)变量名不能和Java关键字重名。
Java变量的命名规则在Java编程语言中非常重要,它是使用Java编程语言编写程序的基本要求。
为了保证Java程序的质量和可扩展性,变量名的规范性非常重要。
有了上述变量命名规则后,我们在编写Java程序时,就可以更好地管理变量。
不仅要注意保持规范性,还要让变量名尽可能容易理解,这样可以更好地提高编程效率。
对于一个比较复杂的Java程序,变量的命名规则更是重要的,因为这可以让代码更加容易维护和扩展。
为了使变量名更容易理解,一般来说,变量名采用帕斯卡方式,即首字母小写,其后每个单词首字母大写。
比如fixedInterestRate,有助于区分fixed和interest。
另外,变量名应该让人迅速理解,比如在计算月供的程序中,变量名monthlyPayment就非常容易理解。
它的名字就是贷款的月付款,因此使用者很容易理解变量的作用。
此外,在Java程序开发中,变量的命名规则还可以用来标识变量的数据类型。
在编写Java程序时,即使是非常熟悉的关键字,也要注意不要把变量名和关键字同时使用,这样会引起混淆。
比如,如果一个变量名是int,这就与Java中的关键字int重名,从而误导了程序开发者。
总之,变量的命名规则是 Java序开发中一个重要的部分,应该严格遵守。
不仅要注意命名规则,还要注意变量名要具有可读性,这样可以更好地提高程序的可维护性和可扩展性。
java代码编写规范
![java代码编写规范](https://img.taocdn.com/s3/m/b5bf03861b37f111f18583d049649b6649d70943.png)
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开发规范文档](https://img.taocdn.com/s3/m/682280d1f9c75fbfc77da26925c52cc58bd6902f.png)
java开发规范文档Java开发规范文档一、命名规范:1.类名使用大驼峰命名法,首字母大写。
2.方法名使用小驼峰命名法,首字母小写。
3.变量名使用小驼峰命名法,首字母小写。
4.常量名使用全大写字母,多个单词之间用下划线连接。
二、代码风格规范:1.代码缩进使用4个空格,不使用制表符。
2.每行代码尽量不超过80个字符。
3.每个方法应该有注释说明其作用。
4.使用行注释或块注释对代码进行注释。
三、类结构规范:1.每个源文件只包含一个类,类名与文件名保持一致。
2.类的字段应该在声明处进行初始化。
3.类的方法按照功能进行分组,相似功能的方法放在一起。
4.类的字段和方法应该用private修饰,对外提供访问的方法使用public修饰。
四、包规范:1.包名采用小写英文字母,多个单词之间用点号(.)分隔。
2.包名应该能够反映出所包含类的功能和用途。
五、注释规范:1.源文件开头应该包含版权声明和作者信息。
2.对于每个类、方法及其参数,应该提供注释,说明其作用和用途。
3.注释应该简洁明了,尽量使用英文。
六、异常处理规范:1.不要在catch块中使用空的catch块。
2.能够处理的异常应该在模块内进行处理,不能处理的异常应该抛出。
七、代码排版规范:1.应该将相关的变量和方法放在一起。
2.应该根据代码逻辑来进行代码的排版,让代码易于阅读。
八、代码复用规范:1.不要重复编写相同功能的代码,应该进行代码复用。
2.可以将公共的代码封装成方法或类,供其他地方使用。
九、版本控制规范:1.使用版本控制工具进行源代码的管理。
2.提交代码前进行代码的版本比较和合并。
以上是Java开发规范的一些常见规范,开发人员应该遵守这些规范,以便提高代码的可维护性和可读性。
规范的遵守可以减少代码的错误和提高代码的质量,有助于团队的合作和项目的开发进度。
JAVA编码规范
![JAVA编码规范](https://img.taocdn.com/s3/m/21c763d749649b6648d7474f.png)
Java编码规范一、命名规范1. 类名首字母应该大写。
属性(成员变量)、方法、对象变量以及所有标识符(如形式参数、实际参数、局部变量)的首字母应小写,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
例如:类名:ThisIsAClassName 属性或方法名:thisIsMethodOrFieldName对象变量:thisIsAClassVariable2. Java 包(Package)属于一种特殊情况,它们全都是小写字母,即便中间的单词亦是如此。
对于全局包,将你的Internet 域名反转并接上包名,例如:pany.package另外,package 行要在import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import 行中包含了同一个包中的不同子目录,则应该用* 来处理。
例如package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里java.io.* 是用来代替InputStream and OutputStream 的。
3. 接口(Interface):采用完整的英文描述符说明接口封装,所有单词的第一个字母大写。
习惯上,名字后面加上后缀able,ible 或者er。
例如:Contactable,Prompter。
4. 组件(Component)使用完整的英文描述来说明组件的用途,末端应接上组件类型。
例如:okButton,customerList,fileMenu。
5. 类中常用方法的命名:类的获取方法(一般具有返回值)一般要求被方法名使用被访问字段名,前面加上前缀get,如getFirstName(), getLastName()。
类的布尔型的判断方法一般要求方法名使用单词is 做前缀,如isPersistent(),isString()。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
1.Java中的命名规则
2.
3.
4.在面向对象编程中,对于类,对象,方法,变量等方面的命名是非常有技巧的。
比如,大小写的区分,使用不同字母开头等等。
但究其本,追其源,在为一个资源其名称的时候,应该本着描述性以及唯一性这两大特征来命名,才能保证资源之间不冲突,并且每一个都便于记忆。
5.
6.包的命名
7.
8.Java包的名字都是由小写单词组成。
但是由于Java面向对象编程的特性,每一
名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。
由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
9.例如: net.frontfree.javagroup
10.
11.类的命名
12.
13.类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多
个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。
14.例如: Circle
15.
16.方法的命名
17.
18.方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开
头。
19.例如: sendMessge
20.
21.常量的命名
22.
23.常量的名字应该都使用大写字母,并且指出该常量完整含义。
如果一个常量名
称由多个单词组成,则应该用下划线来分割这些单词。
24.例如: MAX_V ALUE
25.
26.参数的命名
27.
28.参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在
尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
29.
30.Javadoc注释
31.
32.Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊
的注释,也就是我们所说的Javadoc注释,它是用来记录我们代码中的API的。
Javadoc 注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些HTML标记符和专门的关键词。
使用Javadoc注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
33.例如:
34.
35./**
36.* This is an example of
37.* Javadoc
38.*
39.* @author darchon
40.* @version 0.1, 10/11/2002
41.*/
42.
43.在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权
信息,之后在主程序中可以为每个类、接口、方法、字段添加Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。
在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这些段落将在生成文档中以特定方式显示。
44.虽然为一个设计低劣的程序添加注释不会使其变成好的程序,但是如果按照编
程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美,运行效率高且易于理解的程序,尤其是在多人合作完成同一项目时编程规范就变得更加重要。
俗话说“磨刀不误砍柴工”,花费一点时间去适应一下Java编程规范是有好处的。
缩进风格(indent)
A.K&R风格
这是C程序最早的缩进风格,由C的发明者Ritchie和他的合作者Kernighan率先使用:
if (<cond>) {
<body>
}
其特点,是大括号和if判断在同一行。
通常,缩进为8个空格或一个tab键,但在C++和Java 里,也常缩进4个空格。
最好有人喜欢用两个空格,窃以为不好,不明显。
行宽
一行尽量不要超过80列。
许多终端一个屏幕只能显示80列,为它们想想巴。
如果你的语句太长,想办法折断它,分几列来写。
1.文件之中不得存在无规则的空行,比如说连续十个空行。
一般来讲函数与函数之间
的空行为2-3行。
2.在函数体内部,在逻辑上独立的两个函数块可适当空行,一般为1-2行。
3.每行长度尽量避免超过屏幕宽度,应不超过80个字符
一个函数不要超过200行。
一个文件应避免超过2000行。
@param 参数
@throws抛出
@see 另请参见
@Deprecated 反对的,不赞成使用
@since 从以下版本开始
@author 作者
@version 版本
@exception 抛出
@return 返回。