规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了。如果注释太复杂说明程序需要修改调整,使设计更加合理。 3.注释不仅描述程序做了什么, 还要描述为什么要这样做 ...
规范需要平时编码过程中注意,是一个慢慢养成的好习惯 .基本原则 强制性原则: .字符串的拼加操作,必须使用StringBuilder .try catch的用法 .对于捕获后,不知道干什么事情或者也不知道怎样处理的情况,就不要捕获异常,留给外出层去捕获处理 .返回类型为集合的,在方法声明中必须使用泛型,必须在javadoc中注明什么情况下返回null,什么情况下返回空集合。 .对于方法 变量声明范 ...
2015-05-26 20:37 0 11055 推荐指数:
规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂 2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了。如果注释太复杂说明程序需要修改调整,使设计更加合理。 3.注释不仅描述程序做了什么, 还要描述为什么要这样做 ...
方法的返回类型, 方法参数, 变量声明时均采用接口类型, 而不是实际类型: /** 定义接口变量为接受类型的好处: 1).面向接口编程 一种规范约束 制定者(或者叫协调者),实现者(或者叫生产者),调用者(或者叫消费者)。 接口本质上就是由制定者来协调实现者和调用者之间的关系 ...
做了这么多年开发,对于开发规范方面结合了多方资料,自行总结一些规则,便于参考。 本文档还在不断的补充和完善中,后续持续更新。 命名规范 工程命名 使用项目英文命名或使用拼音,可以使用缩写。工程名称为小写,不使用驼峰式。 正例:智能仓储管理系统InStock,工程名为instock ...
一 编码规范 1.1 命名规范 代码中的命名均不能以特殊字符(如下划线、$#符号)开始或结束。 反例: _name / #Object 2. 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 反例: toubao / lipei ...
第一节:编码过程的命名约定(编码命名规范 ...
类命名规范: 类名使用 UpperCamelCase 风格(首字母都大写),必须遵从驼峰形式。 例如: MessageUtil 抽象类命名使用 Abstract 或 Base 开头 ; 异常类命名使用 Exception 结尾 ; 测试类命名以它要测试的类的名称开始,以 Test 结尾 ...
类命名规范: 类名使用 UpperCamelCase 风格(首字母都大写),必须遵从驼峰形式。 例如: MessageUtil 抽象类命名使用 Abstract 或 Base 开头 ; 异常类命名使用 Exception 结尾 ; 测试类命名以它要测试的类的名称开始,以 Test 结尾 ...
一 包名的书写规范 (Package)推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母,且具有实际的区分意义。 1.1 一般要求1、选择有意义的名字,能快速地传达该类的用途。 2、所有包的命名必须采用小写英文字母。 1.2 实际应用 ...