Java中的一些编程规范_java代码编写怎么才能看起来不乱好多大括号-程序员宅基地

技术标签： java 设计模式开发语言

关于命名

命名的关键是能准确达意。对于不同作用域的命名，可以适当地选择不同的长度。

作用域小的变量（比如临时变量），可以适当地选择短一些的命名方式。除此之外，命

名中也可以使用一些耳熟能详的缩写。

一般可以借助类的信息来简化属性、函数的命名，利用函数的信息来简化函数参数的命

名。

命名要可读、可搜索。不要使用生僻的、不好读的英文单词来命名。除此之外，命名要

符合项目的统一规范，不要用些反直觉的命名。

接口有两种命名方式：一种是在接口中带前缀“I”；另一种是在接口的实现类中带后

缀“Impl”。对于抽象类的命名，也有两种方式，一种是带上前缀“Abstract”，一种

是不带前缀。这两种命名方式都可以，关键是要在项目中统一。

关于注释

注释的目的就是让代码更容易看懂。只要符合这个要求的内容，就可以将它写到注释

里。总结一下，注释的内容主要包含这样三个方面：做什么、为什么、怎么做。对于一

些复杂的类和接口，我们可能还需要写明“如何用”。

注释本身有一定的维护成本，所以并非越多越好。类和函数一定要写注释，而且要写得

尽可能全面、详细，而函数内部的注释要相对少一些，一般都是靠好的命名、提炼函

数、解释性变量、总结性注释来提高代码可读性。

函数、类多大才合适？

函数的代码行数不要超过一屏幕的大小，比如 50 行。类的大小限制比较难确定。

一行代码多长最合适？

最好不要超过 IDE 显示的宽度。当然，限制也不能太小，太小会导致很多稍微长点的语句

被折成两行，也会影响到代码的整洁，不利于阅读。

善用空行分割单元块

对于比较长的函数，为了让逻辑更加清晰，可以使用空行来分割各个代码块。在类内部，成

员变量与函数之间、静态成员变量与普通成员变量之间、函数之间，甚至成员变量之间，都

可以通过添加空行的方式，让不同模块的代码之间的界限更加明确。

四格缩进还是两格缩进？

一般要和原有的代码缩进格数保持一致。除此之外，值得强调的是，不管是用两格缩进还是四格缩进，在使用 tab 键进行缩进时要注意缩进格数，因为在不同的IDE，tab键的缩进格数是不一致的，当然IDE也提供了设置tab键的缩进格数来帮助我们解决此问题，所以到底使用空格还是tab可以根据个人习惯选择。

大括号是否要另起一行？

Java当然比较推荐将大括号放到跟上一条语句同一行的风格，这样可以节省代码行数。但是，将大括号另起一行，也有它的优势，那就是，左右括号可以垂直对齐，哪些代码属于哪一个代码块，更加一目了然。不过还是那句话，要与原有框架代码保持一致。

类中成员的排列顺序

在 Google Java 编程规范中，依赖类按照字母序从小到大排列。类中先写成员变量后写函

数。成员变量之间或函数之间，先写静态成员变量或函数，后写普通变量或函数，并且按照作用域大小依次排列。

关于编码技巧

将复杂的逻辑提炼拆分成函数和类。

通过拆分成多个函数或将参数封装为对象的方式，来处理参数过多的情况。

函数中不要使用参数来做代码执行逻辑的控制。

函数设计要职责单一。

移除过深的嵌套层次，方法包括：去掉多余的 if 或 else 语句，使用 continue、 break、return 关键字提前退出嵌套，调整执行顺序来减少嵌套，将部分嵌套逻辑抽象成函数。

用字面常量取代魔法数。

用解释性变量来解释复杂表达式，以此提高代码可读性

本文链接：https://blog.csdn.net/qq_53916344/article/details/128404460

原作者删帖不实内容删帖广告或垃圾文章投诉

智能推荐

c# 调用c++ lib静态库_c#调用lib-程序员宅基地

文章浏览阅读2w次，点赞7次，收藏51次。四个步骤1.创建C++ Win32项目动态库dll 2.在Win32项目动态库中添加外部依赖项 lib头文件和lib库3.导出C接口4.c#调用c++动态库开始你的表演...①创建一个空白的解决方案，在解决方案中添加 Visual C++ , Win32 项目空白解决方案的创建：添加Visual C++ , Win32 项目这......_c#调用lib

deepin/ubuntu安装苹方字体-程序员宅基地

文章浏览阅读4.6k次。苹方字体是苹果系统上的黑体，挺好看的。注重颜值的网站都会使用，例如知乎：font-family: -apple-system, BlinkMacSystemFont, Helvetica Neue, PingFang SC, Microsoft YaHei, Source Han Sans SC, Noto Sans CJK SC, W..._ubuntu pingfang

html表单常见操作汇总_html表单的处理程序有那些-程序员宅基地

文章浏览阅读159次。表单表单概述表单标签表单域按钮控件demo表单标签表单标签基本语法结构<form action="处理数据程序的url地址“ method=”get|post“ name="表单名称”></form><!--method将表单中的数据传送给服务器处理，get方式直接显示在url地址中，数据可以被缓存，且长度有限制；而post方式数据隐藏传输，_html表单的处理程序有那些

PHP设置谷歌验证器（Google Authenticator）实现操作二步验证_php otp 验证器-程序员宅基地

文章浏览阅读1.2k次。使用说明:开启Google的登陆二步验证（即Google Authenticator服务）后用户登陆时需要输入额外由手机客户端生成的一次性密码。实现Google Authenticator功能需要服务器端和客户端的支持。服务器端负责密钥的生成、验证一次性密码是否正确。客户端记录密钥后生成一次性密码。下载谷歌验证类库文件放到项目合适位置(我这边放在项目Vender下面)https://github.com/PHPGangsta/GoogleAuthenticatorPHP代码示例://引入谷_php otp 验证器

【Python】matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距-程序员宅基地

文章浏览阅读4.3k次，点赞5次，收藏11次。matplotlib.plot画图横坐标混乱及间隔处理_matplotlib更改横轴间距

docker — 容器存储_docker 保存容器-程序员宅基地

文章浏览阅读2.2k次。①Storage driver 处理各镜像层及容器层的处理细节，实现了多层数据的堆叠，为用户提供了多层数据合并后的统一视图②所有 Storage driver 都使用可堆叠图像层和写时复制（CoW）策略③docker info 命令可查看当系统上的 storage driver主要用于测试目的，不建议用于生成环境。_docker 保存容器

随便推点

网络拓扑结构_网络拓扑csdn-程序员宅基地

文章浏览阅读834次，点赞27次，收藏13次。网络拓扑结构是指计算机网络中各组件（如计算机、服务器、打印机、路由器、交换机等设备）及其连接线路在物理布局或逻辑构型上的排列形式。这种布局不仅描述了设备间的实际物理连接方式，也决定了数据在网络中流动的路径和方式。不同的网络拓扑结构影响着网络的性能、可靠性、可扩展性及管理维护的难易程度。_网络拓扑csdn

JS重写Date函数，兼容IOS系统_date.prototype 将所有 ios-程序员宅基地

文章浏览阅读1.8k次，点赞5次，收藏8次。IOS系统Date的坑要创建一个指定时间的new Date对象时，通常的做法是：new Date("2020-09-21 11:11:00")这行代码在 PC 端和安卓端都是正常的，而在 iOS 端则会提示 Invalid Date 无效日期。在IOS年月日中间的横岗许换成斜杠，也就是new Date("2020/09/21 11:11:00")通常为了兼容IOS的这个坑，需要做一些额外的特殊处理，笔者在开发的时候经常会忘了兼容IOS系统。所以就想试着重写Date函数，一劳永逸，避免每次ne_date.prototype 将所有 ios