优秀Java程序员的编程风格

来自《The Elements of Java Style》-《Java编程风格》一书,值得一读的书籍,会让你在细节上节省很多时间,合作之间更加愉快!

  好处不多说了,但是有几个原则如下:

  1.保持原有风格

  2.坚持最小惊奇原则

  3.第一次就做对

  4.记录所有非规范行为

  格式规范:

  1.缩进嵌套的代码:在每个代码块和嵌套中加入缩进,缩进代码,加强可读性。这些地方包括【类定义,内部类定义,方法定义,静态块,for循环语句,if-else语句,try、catch和finally块,匿名内部类,while语句,do-while语句】

  2.断开很长的句子:第一,如果包含了逗号,那么在每一个逗号后面都另起一行,把逗号后面的每一个表达式都和逗号前面的表达式的第一个字母对齐。第二,应该在优先级最低的运算符之前断行。

  3.使用空白:关键字和左括号之间,右括号和紧随其后的关键字,除了”.”之外的运算符与其前后的表达式之间用空格隔开。每个逻辑上独立的方法和代码段之间,定义类或者接口的成员之间,每个类和接口之间应该加入空白行。

  4.不要直接使用Tab控制符:不同环境对Tab控制符的解释也是不同的。

  命名约定:

  1.名称应该具有实际意义

  2.使用人们熟悉的名称

  3.谨慎使用过长的名字,可以使用简明通用的缩写

  4.尽量保留元音字母

  5.缩写词的第一个字母大写

  6.不要使用大小写来区分的名字

  包命名:

  1.用你所在组织的域名的倒序小写形式作为包的根限定词

  2.使用单独的小写词作为每个包的根名

  3.仅当新旧版本二进制兼容的时候,其包可以使用相同的名字,否则,请使用新名字

  类型命名:

  1.类和接口名中的每个单词的第一个字母大写

  类命名:

  1.用名词命名类

  2.具有成组相关属性,静态服务或者常量的类名字使用复数形式

  接口命名:

  1.用名词或者形容词命名接口

  方法命名:

  1.方法名中的第一个单词小写,其后每个单词的第一个字母大写

  2.用动词命名方法

  3.遵循JavaBean中命名属性访问函数方法:set,get,is

  变量命名:

  1.变量命中的第一个单词小写,其后的每个单词的第一个字母大写

  2.用名词命名变量

  3.集合引用名要用复数形式

  4.为不重要的临时变量简历并使用一套标准名字

  字段命名:

  1.使用this字段变量可以区分开局部变量

  参数命名:

  1.构造函数或者”set”方法给字段分配参数赋值,参数名应该和字段名相同

  常量命名:

  1.常量的每个单词均大写,单词之间使用下划线连接

  文档约定:

  1.为使用和维护你的代码的人编写文档

  2.注释和代码要同步

  3.使用积极的语气,省略无用的词语

  注释类型:

  1.用文档注释来描述编程接口

  2.用标准注释格式隐藏代码而不必删除它们

  3.用单行注释解释实现细节

  文档注释:

  1.在编写代码前描述编程接口

  2.为公用,受保护,包,私有成员建立文档

  3.为每个包编写总结和概述

  4.为包的每个应用程序或组编写概述

  注释风格:

  1.对所有文档注释使用统一的格式和组织结构

  2.关键字,标识符和常量应放到<code>…</code>标签中

  3.将代码放入<pre>…</pre>标签中

  4.在标识符第一次出现的时候用{@link}标签

  5.为Javadoc标签简历并使用一套固定的顺序

  6.使用第三人称叙述的形式

  7.编写独立的概述

  8.省略概述中动作和服务的主语

  9.省略事物概述中的对象和动词

  10.使用this而不是the来指代当前类中的实例

  11.方法名或者构造函数名不需圆括号,除非你想突出一个特殊的签名

  注释内容:

  1.每个类、接口、字段和方法都编写概述

  2.完整描述每个方法的签名

  3.包含示例

  4.为前置、后置、不变条件编写文档

  5.为已知的缺陷和不足编写文档

  6.为同步语法编写文档

  内部注释:

  1.仅添加有助于理解你的代码的内部注释

  2.描写代码为什么这样做,而不是在做什么

  3.避免使用行尾注释

  4.用行尾注释解释局部变量声明

  5.建立并使用一套关键词来标识尚未解决的问题

  6.在嵌套程度高的控制结构中标记出嵌套结束位置

  7.如果两个case标记之间没有break语句,就在中间加入“fall-through”注释

  8.标记空语句

  编程约定:

  1.将表示基础数据类型的类声明为final类型

  2.通过本地类型和其他具体类型建立具体类型

  3.定义小的类和小的方法

  4.定义子类,以便任何使用超类的地方都可以使用子类

  5.使所有字段私有

  6.使用多态来替代instanceof

  类型安全:

  1.以java.lang.Object包装通用类,提供静态类型检查

  2.以类的形式封装枚举类型

  3.尽量使用泛型

  语句和表达式:

  1.用等价的方法替换重复的、复杂的表达式

  2.使用块语句代替控制流结构的表达式

  3.使用括号明确操作顺序

  4.在switch语句中的最后一个case体使用break语句

  5.使用equals(),而不是==来检测对象的对等关系

  构造:

  1.构造状态有效的对象

  2.不要从构造函数中调用非final方法

  3.用嵌套的构造函数消除冗余代码

  异常处理:

  1.使用不受检查、运行时的异常来报告可能在程序逻辑中出错的严重未查明错误

  2.使用检查异常来报告可能发生,而在正常的程序运行时极少发生的错误

  3.用返回代码报告可预知的状态改变

  4.仅转化异常来添加信息

  5.不要私自处置运行时或者错误异常

  6.用finally语句块释放资源

  断言:

  1.按照约定编程

  2.用无用代码消除机制实现断言

  3.用断言捕捉代码中的逻辑错误

  4.用断言检测方法的前置条件和后置条件

  并发:

  1.仅在适当的地方使用线程

  同步:

  1.避免同步

  2.用同步的包装器,提供同步接口

  3.如果方法包含几个不需要同步的重要操作,那么不要同步整个方法

  4.读写实例变量的时候避免不必要的同步

  5.使用notify()而不是notifyAll()

  6.为同步初始化使用双重检查模式

  效率:

  1.使用懒惰初始化

  2.避免创建不必要的对象

  3.重新初始化并重新使用对象,尽量不要新建对象

  4.把优化工作留在日后

  打包约定:

  1.将经常使用、更改、同时发布或者互相依存的类型,放在同一个包里

  2.共同封闭原则

  3.重用/发布等价原则

  4.无环依赖原则

  5.将不稳定的类和接口隔离在单独的包中

  6.易于修改的包不要依赖于难以修改的包

  7.最大化抽象最大化稳定性

  8.将高层设计和架构作为稳定的抽象,组织为稳定的包

 为了让学习变得轻松、高效,今天给大家免费分享一套Java教学资源。帮助大家在成为Java架构师的道路上披荆斩棘。需要资料的欢迎加入学习交流群:9285,05736

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/503094.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

远程服务器返回错误: (405) 不允许的方法_四指炸鸡总部远程协助选址,5大加盟优势,0基础即可开店...

四指炸鸡以消费者需求为发展战略&#xff0c;适时推出美味炸鸡产品&#xff0c;外焦里嫩&#xff0c;汤汁浓郁。多种产品、多种口味适合于男女老幼&#xff0c;在市场上发展非常好。很多人都想加盟进来&#xff0c;四指炸鸡总部远程协助选址&#xff0c;5大加盟优势&#xff0c…

盘点常用Java排序算法

本文主要介绍Java的七种常见排序算法的实现&#xff0c;对选择排序、插入排序、冒泡排序、归并排序、快速排序、希尔排序、最小堆排序进行原理分析与实例介绍&#xff0c;下面一起来看一下吧&#xff1a; 一、选择排序(SelectSort) 基本原理&#xff1a;对于给定的一组记录&…

单点登录 cas 设置回调地址_统一身份认证和单点登录的区别

首先大家会遇到这样一个问题&#xff0c;统一身份认证和单点登录的概念是什么&#xff1f;百度百科对统一身份认证的定义所谓身份认证&#xff0c;就是判断一个用户是否为合法用户的处理过程。最常用的简单身份认证方式是系统通过核对用户输入的用户名和口令&#xff0c;看其是…

java学习书籍推荐

一、Java编程入门类 对于没有Java编程经验的程序员要入门&#xff0c;随便读什么入门书籍都一样&#xff0c;这个阶段需要你快速的掌握Java基础语法和基本用法&#xff0c;宗旨就是“囫囵吞枣不求甚解”&#xff0c;先对Java熟悉起来再说。用很短的时间快速过一遍Java语法&…

如何侦听网线数据_网络工程师 | 七类网线水晶头又如何制作?

什么是七类网线我们在常规使用中用的最多就是超5类线了&#xff0c;对网络要求高的单位布线会使用六类网线。但是对于七类网线可能接触的不多&#xff0c;它主要为了适应万兆位以太网技术的应用和发展。但它不再是一种非屏蔽双绞线了&#xff0c;而是一种屏蔽双绞线。七类网线是…

Java转JSON串的几种方式

以下总结一下java转JSON串的几种方式&#xff1a; 1、将java对象转成json串 2、通过JSONObject生成json串 3、通过json字符串生成json串 代码通过阿里的fastjson包实现。 代码如下&#xff1a; 1、Person类&#xff0c;包含Crad的List package com.doit8.test.jsontest.…

exfat最佳单元大小_双动圈四喇叭单元的头戴式耳机,DACOM HF002上手体验

蓝牙耳机近两年发展迅速&#xff0c;特别是入耳式蓝牙耳机的发展&#xff0c;轻便的设计无论是携带还使用都非常方便&#xff0c;但入耳式耳机有一个比较大的通病是容易使耳朵胀痛&#xff0c;并且由于耳机单元的过小&#xff0c;先天地影响着耳机的声音&#xff0c;虽然有顶级…

学Java方向的学生如何找实习的工作?

是这个大三的学生&#xff0c;是学Java方向的&#xff0c;我想知道&#xff0c;实习的工作好找吗&#xff1f;应该会什么&#xff1f;目前会SE、EE&#xff0c;数据库MySQL、 sqlserver。sql语句也会&#xff0c;C语言&#xff0c;c也会一点。可以用框架做增删改查。这样够了吗…

e3d教程做logo教程_看了教程还是不会做平面设计?关键的方法给你揭秘!附450集教程...

设计没有捷径&#xff0c;正确的学习方法简单总结起来就是多看、多做、多想&#xff0c;不断重复。【450集教程领取方式见文末】平面设计、PS、Photoshop、PS教程、PS字体、PS笔刷、PS软件、PS插件、PS2020、PS技巧多看&#xff0c;是提高审美的有效手段&#xff0c;优秀的设计…

python运维常用模块-运维常用python库模块

sutil&#xff1a; 是一个跨平台库&#xff08;https://github.com/giampaolo/psutil&#xff09;能够实现获取系统运行的进程和系统利用率&#xff08;内存&#xff0c;CPU,磁盘&#xff0c;网络等&#xff09;&#xff0c;主要用于系统监控&#xff0c;分析和系统资源及进程的…

你知道Java的四种引用类型吗

在Java中提供了四个级别的引用&#xff1a;强引用&#xff0c;软引用&#xff0c;弱引用和虚引用。在这四个引用类型中&#xff0c;只有强引用FinalReference类是包内可见&#xff0c;其他三种引用类型均为public&#xff0c;可以在应用程序中直接使用。引用类型的类结构如图所…

k8s学习 — (DevOps实践)第十三章 DevOps 环境搭建

k8s学习 — &#xff08;DevOps实践&#xff09;第十三章 DevOps 环境搭建 学习资料1 Gitlab1.1 安装 Gitlab1.2 页面配置1.3 配置 Secret1.4 为项目配置 Webhook1.5 卸载 2 Harbor2.1 安装 Harbor2.1 配置 Secret 3 SonarQube3.1 安装 SonarQube3.2 生成服务 token3.3 创建 We…

电脑打字学习_寒假就这样做!即不让孩子烦,还能让他有进步,开学就能迅速进入学习状态!...

部编本下册教材寒假预习可点击查看&#xff1a;六年级 五年级 四年级 三年级 二年级 一年级转眼间&#xff0c;一学期的学习又结束了&#xff0c;寒假模式正式开启。在这一个多月的寒假期间&#xff0c;孩子离开了学习&#xff0c;摆脱了老师的教育&#xff0c;如果家长再…

sap 供应商表_SAP系统玩阴的?

SAP系统玩阴的&#xff1f;近日和项目上的ABAP开发顾问一起弄一个自开发的报表。其中某个栏位的取值需要从批次主数据里抓取到供应商代码&#xff0c;然后根据供应商代码取到供应商名称等。为此笔者需要备功能说明书&#xff0c;在说明书里笔者需要将具体取值逻辑写清楚。要取到…

Java设计模式:单例模式

设计模式&#xff08;Design Pattern&#xff09;&#xff1a;是一套被反复使用&#xff0c;多数人知晓的&#xff0c;经过分类编目的&#xff0c;代码设计经验的总结。 目的&#xff1a;使用设计模式是为了可重用性代码&#xff0c;让代码更容易被他人理解&#xff0c;保证代…

滤波器的优点_声光可调谐滤波器

目前声光可调谐滤波器主要应用于光通信领域。它具有调谐速度快&#xff0c;可调谐范围宽、插入损耗低和通道驱动功率低等优点&#xff0c;并且可以实现多波长同时选择&#xff0c;因此在未来的波分复用网络中极有应用潜力。此外&#xff0c;声光可调谐滤波器还常用于半导体激光…

想学习大数据的同学一定要学习Java吗

一、学习大数据&#xff0c;一定要学习java吗? 首先&#xff0c;大家要清楚一点&#xff0c;学习Java的目的是什么&#xff0c;Java它本身是一门计算机编程语言&#xff0c;而进入大数据的学习&#xff0c;无论你有何基础&#xff0c;是零基础还是有过相关的学习经验&#xf…

qt多线程服务器_常见网络服务器并发模型

点击蓝字 关注我们近些年&#xff0c;随着互联网的大发展&#xff0c;高并发服务器技术也快速进步&#xff0c;从简单的循环服务器模型处理少量网络并发请求&#xff0c;演进到解决C10K&#xff0c;C10M问题的高并发服务器模型。本文主要以TCP为例&#xff0c;总结了几种常见的…

如何在vb.net中取得两时间的毫秒差_科技品牌软文营销如何写出一篇爆文?

随着互联网的发展&#xff0c;尤其是移动互联网的发展&#xff0c;让营销方式从传统的线下电视报纸广告逐渐转移到线上的软文营销。软文营销因为其快捷&#xff0c;方便&#xff0c;性价比高的特点受到了很多品牌的追捧。文章是软文营销的前提&#xff0c;如何写好一篇好的文章…

Java开发领域的大牛有哪些

Java开发领域的大牛有哪些 1、James Gosling 在他12岁的时候&#xff0c;他已能设计电子游戏机&#xff0c;帮忙邻居修理收割机。大学时期在天文系担任程式开发工读生&#xff0c;1977年获得了加拿大卡尔加里大学计算机科学学士学位&#xff0c;1983年获得了美国卡内基梅隆大学…