Java开发规范及其技巧分享

in java with 0 comment

  每个类及方法都要有合理的注释,并且对注释要持续维护

  根据接口需求编写单元测试用例,再编写实现类使得单元测试通过,如此循环往复以使得所有的单元测试通过

  要求每个Java方法的代码行数不能超过100行

  代码编写按照功能划分,一个接口分为多个方法,每一个方法做什么事情,做到思路清晰

  接口设计尽量做到多兼容性,方便后期开发

  不使用MySQL数据库外键约束,通过应用程序逻辑实现关联约束

  适当建立索引,经常作为查询条件的字段、唯一性程度高、长度不是很长的、数量不宜太多,一般一个表的索引数目在5个以内

  表名长度不能超过30个字符,表名最好选择一个单词,能够准确清晰明了地表示实体含义,若必须多个单词则以下划线“_”分隔,单词所有字母均小写

  表名不要使用汉语拼音表示,不需要带前缀

  数据库字段名全部采用小写英文单词,单词之间用”_”隔开。字段长度不能超过30个字符

  如果该字段是主键,则在单词后加_id,在设计表时如果该字段是该数据的唯一属性可以使用_id表示该字段名,方便以后的多期项目

  如果该字段表示的是时间,则使用_time为后缀

  数据库表设计尽量做到兼容性,方便后期开发

  在软件工程领域,源程序的风格统一标志着可维护性、可读性,是软件项目的一个重要组成部分。

  通过建立代码编写规范,形成开发小组编码约定,提高程序的可靠性、可读性、可修改性、可维护性、可继承性和一致性,可以保证程序代码的质量,继承软件开发成果,充分利用资源,使开发人员之间的工作成果可以共享。

X O