首页 > 其他分享 >开发规范

开发规范

时间:2022-09-20 09:36:48浏览次数:49  
标签:驼峰 换行 规范 空格 开发 使用 命名 大括号

Java开发手册

一、编程规约

(一)命名风格

  1. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

  2. 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文。

  3. 类名使用 UpperCamelCase 风格,必须遵从驼峰形式(大驼峰)

  4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从

    驼峰形式(小驼峰)。

  5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

    • 抽象类命名使用 Abstract 或 Base 开头;

    • 异常类命名使用 Exception 结尾;

    • 测试类命名以它要测试的类的名称开始,以 Test 结尾。

  6. 中括号是数组类型的一部分,数组定义如下:String[] args;

  7. POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。

  8. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用

    单数形式。

  9. 杜绝完全不规范的缩写。

  10. 如果使用到了设计模式,建议在类名中体现出具体模式。

(二)代码格式

  1. 大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果

    是非空代码块则:

    1) 左大括号前不换行。

    2) 左大括号后换行。

    3) 右大括号前换行。

    4) 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。

  2. 左右小括号和字符之间不出现空格。

  3. if/for/while/switch/do 等保留字与括号之间都必须加空格。

  4. 任何二目、三目运算符的左右两边都需要加一个空格。

  5. 单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:

    1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进。

    2) 运算符与下文一起换行。

    3) 方法调用的点符号与下文一起换行。

    4) 在多个参数超长,在逗号后换行。

    5) 在括号前不要换行。

  6. 方法参数在定义和传入时,多个参数逗号后边必须加空格。

  7. IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,

    不要使用 windows 格式。

  8. 没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。

标签:驼峰,换行,规范,空格,开发,使用,命名,大括号
From: https://www.cnblogs.com/chengyacheng/p/16709912.html

相关文章

  • BPMN2.0 规范学习记录
    BPMN2.0(BusinessProcessModelingNotation2.0,译为:业务流程模型注解Version2.0)是业务流程模型的一种标准注解,这个标准是由OMG(ObjecgtManagementGroup,译为:对象管理组织......
  • Python桌面应用开发 ——— PyQT5
    Qt是一个跨平台的C++开发库,主要用来开发图形用户界面(GraphicalUserInterface,GUI)程序,当然也可以开发不带界面的命令行(CommandUserInterface,CUI)程序。PyQT5简介PyQt......
  • MyBatis 多条件查询、动态SQL、多表操作、注解开发,应有尽有,一网打尽!
    点击关注程序员闪充宝2022-09-1917:42发表于山西MyBatis封装了JDBC通过Mapper代理的方式,以前繁琐的操作通过“属性与字段映射”就简单化解,MyBatis的动态SQL完美展现了D......
  • JavaEE企业级应用开发教程 pdf
    高清扫描版下载链接:https://pan.baidu.com/s/19awdYpedqslkeYxfU6YSYQ点击这里获取提取码 ......
  • 敏捷开发的QA再怎么做
    QA习惯拿着事先准备好的检查单,对项目一条条做审核,发现问题开不符合报告,敏捷测试就是在敏捷开发模式下对软件进行的测试,要求尽早测试、频繁测试,以及时提供反馈。为了快速响......
  • ArcGIS Pro 二次开发缓冲区代码
    varvalueArray=awaitQueuedTask.Run(()=>{varg=newList<object>(){geometry,};//Createsa8000-meter......
  • AOS手持终端应用软件开发总结
    AOS手持终端是一类智能手机安装的AOS或EMSS(最近的新版本名字改成emss了)操作系统的国内特有应用软件开发与运行平台。主要应用于军工,国防,电信,电网等特殊行业。目前AOS系统......
  • linux统信OS配置C#+VScode的asp.net MVC开发环境(参考Ubuntu)
    NETCore是一个免费和开源的软件框架,设计时考虑到了Linux和macOS。它是.NET框架的跨平台继承者,适用于Linux、macOS和Windows系统。Dotnet核心框架已经为引导项目提供了脚......
  • 使用J2EE 登录实例开发
    我们先了解下Servlet的生命周期Servlet部署在容器里,其生命周期由容器管理。概括为以下几个阶段:1)容器加载Servlet类。当第一次有Web客户请求Servlet服务或当W......
  • 开发人员如何避免太疲劳
    目标:平衡生活和工作学到的任何东西或者了解到的任何信息都可能提高成功率。始终是不断接近目标但是从来没有人和事能保证完成目标。接受这种始终不完美的状态,反而比强......