`
wxb880114
  • 浏览: 683522 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

Java开发规范

 
阅读更多
   统一化规范化的软件开发是尤为重要的,在软件开发的生命周期中,软件开发过程的投入不是最大的,主要是后期软件的维护,在维护过程中,部署、bug修改、新功能增加、二次开发等等,若是没有规范化的代码编写,在后期的维护工作中,必然成为一件劳民伤财的事,极其的坑爹!
   在java开发规范中主要有以下四个方面:
   1.基本命名规范
   2.常量命名规范
   3.变量命名规范
   4.方法命名规范
   5.包的命名规范

  基本命名规范:
     字符集在26个英文字母、0-9数字、下划线
     命名需要有一定的意义,推荐采用问题域的术语命名
     命名尽量的短,如果命名太长,可以采用别名的方式,或者缩写简化命名
     不要用前导下划线,也不要在命名后下划线
 

  常量命名规范:
     所有的字符都必须大写,采用有意义的单词组合表达,单词与单词之间用“_”下划线隔开。
     命名尽量简短,不要超过16个字符。

  变量命名规范
     避免在命名中采用数字,除非有其他特殊含义
     变量名称是名词意义
     第一个单词全部小写,后续的每个单词采用首字母大写,其余小写。
     命名尽量简短,不要超过16个字符。
     除了生命周期很短的临时变量外,避免采用单字符作为变量名。
     某些情况下,变量可能需要加上类型前缀,后缀实体部分没有任何间隔。

  方法命名规范
     命名多数为动词结构。
     第一个单词小写,后续的每个单词采用首字母大写,其余小写,没有特别理由不用下划线作为分隔符。
     构造方法的命名与类名一致。
     属性方法命名遵循JavaBean标准,getter/setter。boolean型采用is+属性名。

  JSP目录规范
 
 
  JAVA目录规范

  注释规范
  注释规范是为了阅读代码方便,快速认识功能实现,包括基本规范、三种注释的说明、变量注释、方法注释、算法注释、修改记录。
  注释应该使代码清晰易懂,简单明了,只要提供能够明确理解程序所必要的信息就可以了
注释不仅要描述程序做了什么,还要描述为什么要这么做,以及约束。
对于一般的getter、setter方法不用注释,注释不能嵌套,注释使用中文编写。
  三种注释方式:文档注释、行注释、块注释。

  编码规范
  编码规范主要包括基本规则、类编写规范、变量编写规范、方法编写规范、语言使用及书写规范。
  基本原则:
  一个类文件最好不超过2000行,尽可能缩小对象的作用域,这样对象的可见范围和生存期也都会尽可能得小,一个方法所完成的功能要单一,不同的功能封装为不同的方法,尽可能的处理异常或转换异常,不要一味的包装异常。
  如果对象在特定范围内必须被清理,使用带有finally子句的try块,在finally子句进行清理。
  使用java标准库提供的容器,选择HashSet来处理集合,选择HashMap来处理关联数组,选择linkList来处理堆栈和队列,它对顺序访问进行了优化,向List中间插入与删除的开销小,但随机访问则较慢。
   方法编写规范
   对成员变量不要轻易的采用public成员变量。
   空方法中方法声明和函数体可都在一行。如: void func(){}
  避免过多的参数列表,尽量控制在5个以内,若需要传递多个参数时,使用一个容纳这些参数的对象进行传递,以提高程序可读性和可扩展性
  方法中的循环嵌套不能超过2层,
  每个方法尽量代码行数尽量不要超过100行(有效代码,不包括注释),但必须保证逻辑的完整性。




 
分享到:
评论

相关推荐

    阿里巴巴Java开发规范(正式版)

    《阿里巴巴Java开发规范》是Java开发者的一份重要指南,它为编写高质量、可维护的代码提供了明确的标准和建议。这份规范不仅适用于阿里巴巴集团内部的开发团队,也对广大Java开发者有着广泛的参考价值。以下是该规范...

    阿里java开发规范插件idea eclipse

    阿里Java开发规范插件是为Java开发者提供的一种工具,它主要应用于IntelliJ IDEA和Eclipse这两个主流的Java集成开发环境(IDE)。该插件旨在帮助开发者遵循阿里巴巴制定的Java编码规范,提升代码质量和可读性,从而...

    阿里巴巴JAVA开发规范word文档

    阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴...

    谷歌Java开发规范.rar

    《谷歌Java开发规范》是Google公司为Java开发者提供的一套详尽且权威的编码指导原则,旨在提升代码质量,提高团队协作效率,并降低维护成本。这份规范不仅关注语法层面的约定,更注重代码的可读性、可维护性和可扩展...

    JAVA开发规范手册1.50

    JAVA开发规范手册1.50 本手册是阿里巴巴集团技术团队的集体智慧结晶和经验总结,旨在提高Java开发者的综合素质和软件开发质量。手册共分七个维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构...

    Java开发规范.docx

    Java 开发规范 Java 开发规范是阿里巴巴 Java 开发手册的核心内容,本手册旨在码出高效,码出质量。现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件...

    Java开发规范脑图|java开发规范思维导图.zip

    Java开发规范是编程实践中至关重要的一个方面,它旨在提高代码质量、可读性、可维护性和团队协作效率。本资源包含一个"Java开发规范思维导图",由"小小鱼儿小小林"创建,采用xmind工具制作,允许进一步编辑和修改。...

    阿里巴巴 Java 开发规范手册

    《阿里巴巴 Java 开发规范手册》是一份旨在提升 Java 代码质量、可读性和维护性的标准文档,由阿里巴巴集团技术部制定。这份规范涵盖了命名规约、编程规约等多个方面,旨在帮助开发者遵循最佳实践,提高代码的一致性...

    Java 开发规范

    Java 开发规范 Java 开发规范是一套编程规约,旨在提高代码的可读性、可维护性和可重用性。本规范涵盖了命名规约、编程规约、代码组织规约和注释规约等多个方面。 命名规约是编程中最基本的规范,包括类名、方法...

    阿里巴巴-Java开发规范插件-Eclipse离线安装包

    《阿里巴巴Java开发规范插件Eclipse离线安装详解》 在Java开发中,遵循一套统一的编码规范至关重要,它能够提高代码的可读性,降低维护成本,提升团队协作效率。阿里巴巴作为中国领先的互联网企业,推出了针对Java...

    java开发规范.pdf

    阿里Java开发规范是一套详尽的编程规范,由阿里巴巴集团技术部于2016年12月首次公开,旨在指导Java开发人员编写高质量、易维护、可读性强的代码。以下是从给定文件中提取的知识点。 命名规约: 1. 编程相关命名不...

    新手入门必备java开发规范

    Java开发规范是编程实践中不可或缺的一部分,它为开发者提供了一套标准和最佳实践,以确保代码的质量、可读性以及团队间的协作效率。阿里巴巴作为中国知名的互联网企业,其发布的《阿里巴巴Java开发规约手册》是业界...

    阿里巴巴java开发规范高清版pdf

    阿里巴巴Java开发规范是一套详细而严谨的Java编程和项目开发规范。它涵盖了编程规约、异常处理、日志规范、数据库操作、工程结构及安全等多个方面,旨在统一团队开发风格,提高代码质量、可维护性和安全性。本知识...

    阿里巴巴Java开发规范插件Eclipse离线安装包

    阿里巴巴Java开发规范插件是专为Java开发者设计的一款工具,旨在提高代码质量和开发效率,遵循阿里巴巴内部制定的一系列编码标准和最佳实践。这个Eclipse离线安装包是为了解决那些无法连接到互联网或者内网环境下的...

    阿里巴巴Java开发规范最新PDF20180208

    阿里巴巴Java开发规范是一套详细的编程准则,旨在指导Java开发者编写出高质量、可维护、统一风格的代码。这些规范涉及到编程规约、异常处理、日志记录、数据库操作、工程结构以及安全等多个方面。下面将对这些规范...

    阿里巴巴java开发规范

    《阿里巴巴Java开发规范》是Java开发者的一份重要指南,它由阿里巴巴集团编撰,旨在提升团队协作效率,保证代码质量,降低维护成本。这份规范详细规定了Java编程中应遵循的编码风格、命名规则、异常处理、并发控制、...

    培训考试-笔试题(Java开发规范)(含答案).docx

    Java开发规范是编程实践中的一套准则,旨在提高代码的可读性、可维护性和团队协作效率。本题涉及的Java开发规范主要涵盖命名规范、接口设计、代码格式、注释规则以及类和方法的设计原则。 1. **命名规范**: - ...

    java开发规范

    Java开发规范编码规范开发的规范点击上传资源即表示您确认该资源不违反资源分享的使用条款,并且您拥有该资源的所有版权或者上传资源的授权

    java开发规范化模板

    java开发规范化模板codetemplates,开发中类、方法、变量等的规范化、格式化处理。

    全面的JAVA开发规范(pdf)

    阿里工程师们严格遵循的Java开发规范,从命名风格、代码格式、OOP规约、集合处理、并发处理、控制语句、注释规约等方面为开发者提供了全面的代码编写标准,以便培养高质量代码的编写能力,避免代码风格杂乱无章,...

Global site tag (gtag.js) - Google Analytics