重庆城乡建设网站首页,wordpress 调用描述,服务之家做网站简单吗,长尾关键词挖掘网站目录
命名规范
代码格式
OOP规约
集合规范
并发规范
SQL语句规范
SQL 建表规范
SQL 索引规范
SQL 查询规范
控制语句规范
Javadoc 规范
其他规范 命名规范
1、包名#xff1a;使用小写字母#xff0c;多个单词之间用.分隔#xff0c;例如#xff…
目录
命名规范
代码格式
OOP规约
集合规范
并发规范
SQL语句规范
SQL 建表规范
SQL 索引规范
SQL 查询规范
控制语句规范
Javadoc 规范
其他规范 命名规范
1、包名使用小写字母多个单词之间用.分隔例如com.example.mypackage。
2、类名和接口名使用大驼峰命名法即每个单词首字母大写例如MyClass、MyInterface。
3、方法名使用小驼峰命名法即第一个单词小写后面每个单词首字母大写例如myMethod。
4、变量名同样使用小驼峰命名法例如myVariable。
5、常量名使用大写字母和下划线命名例如MY_CONSTANT。
6、参数名与变量名相同使用小驼峰命名法。
7、类型参数名使用单个大写字母例如T、E。
8、枚举常量名常量名全部大写单词间用下划线隔开例如MAX_NUMBER。 注意所有的命名应该对应相应的单词避免无意义的命名。 代码格式
1、缩进使用四个空格进行缩进不要使用制表符。
2、换行每行代码长度不应超过80个字符。当一行代码过长时可以通过换行来使其更易读。
3、空格在二元运算符如赋值、逻辑运算符等两侧加上空格但在一元运算符如取反运算符之后不加空格。例如int result 1 2; 和 if (!flag) { ... }。
4、大括号在代码块的左大括号前加上一个空格右大括号独占一行除非是空代码块。例如
if (condition) {// 代码
} else {代码
} 5、注释注释应该清晰明了简洁准确且不应与代码格式冲突注释应该放在需要解释的代码行的上方或者与代码保持一定的间距。
6、异常处理每个 try 块都应该有一个对应的 catch 块或者 finally 块。catch 块中应该包含恰当的异常处理代码。
其他禁止出现代码多行注释禁止出现无意义的空格禁止出现行末空格等等。 OOP规约
1、类命名类名采用大驼峰命名法例如UserInfo
2、方法命名方法名采用小驼峰命名法例如getUserName()
3、变量命名变量名采用小驼峰命名法例如userName
封装性封装性是面向对象编程的核心要求类的属性和方法要定义为private只能通过public方法来访问和修改
继承性继承性是面向对象编程的重要特性要求子类和父类之间要保持适当的关系不应该随意修改父类的属性和方法
多态性多态性是面向对象编程的又一重要特性要求方法的参数类型和返回值类型要尽量使用父类或接口类型便于扩展和维护。 集合规范
集合在声明后应该立即初始化避免出现空指针异常
集合的容量应该在初始化时指定以提高程序的效率
集合的类型应该尽量使用泛型以提高代码的健壮性和可读性
集合的遍历应该使用迭代器或foreach循环不应该使用普通的for循环。 并发规范
线程安全多线程环境下应该保证程序的线程安全性防止出现数据竞争和死锁等问题
同步机制在需要修改共享变量的地方应该加上同步机制以保证数据的一致性和完整性
线程池在使用多线程时应该使用线程池以避免线程的创建和销毁带来的性能损失。 SQL语句规范
每条 SQL 语句占一行避免多条语句写在同一行
SQL 语句的关键字统一使用大写
表名、列名等标识符采用小写多个单词用下划线连接
SQL 语句中的字面量如字符串、数字使用单引号括起来
注释可以使用双短横线--或 /* */ 表示。
SQL 建表规范
主键、唯一索引、普通索引等都需要命名名称必须表达清楚索引的含义
表名应该采用小写字母单词之间用下划线隔开例如user_info
字段名也应该采用小写字母单词之间用下划线隔开例如user_name
表字段必须加注释注释内容应该表达字段的含义、业务含义以及约束条件
应该根据实际情况选择合适的数据类型以尽可能地节省存储空间
不使用保留字作为字段名以避免出现不必要的错误
尽量避免使用 MySQL 关键字作为表名或列名如 select、order 等。
SQL 索引规范
索引字段顺序应该优化常用的放前面复合索引优先考虑常用组合
多表连接的 SQL 语句应该在关联字段上建立索引以提高查询效率
避免在索引列上使用函数操作如select * from table where substr(name,1,3)abc应改为select * from table where name like abc%以充分利用索引的优势。
注意索引可以提高查询的效率但过多的索引会降低。
SQL 查询规范
避免使用 SELECT *只选择必要的字段
避免在 WHERE 子句中对索引字段使用不等于操作符如where id10这样会导致索引失效
避免使用子查询或者 JOIN 进行大量数据的计算和查询尽量减少对数据的扫描。
总之SQL 语句的书写规范、建表规范、索引规范、查询规范等都可以提高 SQL 的效率减少错误和异常。在实际开发中我们应该尽量遵循这些规范写出高效、安全、易于维护的 SQL 语句。 控制语句规范
1、不能在条件判断中使用复杂的表达式应该将复杂表达式的结果赋值给一个变量然后在条件判断中使用变量。
2、在判断 null 值时应该使用 isnull() 或者 is not null 而不是 null 或者 ! null。
3、switch 语句必须带有 default 分支并且 default 分支放在最后。
4、使用循环时应该注意
在使用 for 循环时应该尽可能地使用增强型 for 循环来代替传统的 for 循环以提高代码的可读性和可维护性 在使用 while 循环时应该注意循环条件的正确性避免出现死循环 对于 do-while 循环应该尽可能地避免使用以提高代码的可读性和可维护性。
5、在使用递归时应该注意递归深度的控制避免因递归深度过大导致程序崩溃。
6、在使用 switch 语句时应该注意
switch 语句中的每个 case 分支都应该使用 break 语句或者 return 语句结束以避免出现意外的控制流程
当 switch 语句中的 case 分支较多时应该使用 break 语句或者 return 语句来明确地结束每个分支 对于可能出现 null 值的情况应该使用 switch 语句的 default 分支来处理以避免出现空指针异常。 Javadoc 规范
【Javadoc规范是Java开发中的一种文档规范用于生成API文档提供代码文档化和注释工具。Javadoc注释是一种特殊的Java注释可以提取类、方法、变量等信息生成HTML格式的API文档。Javadoc注释以/**开头以*/结尾可以用于注释类、方法、变量等元素】
其中包含丰富的标签可以描述注释的各种属性例如 1、param用于描述方法参数的名称和说明 2、return用于描述方法返回值的类型和说明 3、throws用于描述方法可能抛出的异常 4、see用于引用其他类、方法或变量 5、deprecated用于标注已经过时的方法或变量。
Javadoc注释不仅可以用于生成API文档还可以提高代码的可读性和可维护性方便其他开发人员理解代码和接口。因此在Java开发中Javadoc规范是一个非常重要的文档规范。注意 对于每个类、接口、方法、字段都应该写一个对应的Javadoc注释描述其作用、参数、返回值等信息。 其他规范
异常处理规范包括异常处理的方式、处理顺序、日志记录等的规范要求程序要能够正确处理异常避免出现不必要的错误 日志规范包括日志的级别、格式、位置等的规范要求程序要能够记录必要的日志信息便于排查和解决问题 性能规范包括代码的优化、避免资源浪费、减少网络传输等的规范要求程序要具有高效性、可伸缩性和可扩展性 安全规范包括密码存储、数据加密、SQL注入、XSS攻击等的安全规范要求程序要能够保证数据的安全性和可靠性 测试规范包括单元测试、集成测试等的规范要求程序要具有可测试性和可维护性。
