java代码规范(适合写程序之前先了解有助于开发协同)

news2024/11/16 6:33:24

目录

一、类定义

二、方法定义

三、接口定义

四、变量定义

1、命名规范:

2、类型规范:

3、常量规范:

五、static关键字

1、静态变量(类变量):

2、静态方法(类方法):


一、类定义

  1. 类名应该使用大写字母开头的驼峰命名法。例如,PublicClass。
  2. 类定义应该包含在一个与类名同名的文件中。例如,PublicClass类的定义应该保存在名为PublicClass.java的文件中。
  3. 类定义应该包括访问修饰符,通常是public,表示该类可以被其他类访问。如果没有指定访问修饰符,则默认为package-private(即只有在同一包中的类可以访问)。
  4. 类定义可以包含类级别的变量(称为字段)和方法。字段和方法也应该使用驼峰命名法,并且方法名应该以动词开头。
  5. 类定义可以包含构造函数,用于初始化类的实例。构造函数应该与类名同名,没有返回类型,并且可以在其中初始化类的字段。
  6. 如果类定义包含方法,则应该为每个方法提供适当的访问修饰符,例如public、private、protected或默认(package-private)。方法的访问修饰符应该根据方法的用途和访问需求进行选择。
  7. 类定义可以包含注释和文档,以便其他人可以理解代码的功能和用途。注释应该清晰明了,并且应该使用JavaDoc格式进行编写。

二、方法定义

在Java中,方法的定义也需要遵循一定的规范,这有助于提高代码的可读性和一致性。以下是一些Java方法定义的规范:

  1. 方法命名:方法名应该使用小写字母开头的驼峰命名法。动词应该用来表示方法的行为。例如,calculateSum()。
  2. 访问修饰符:每个方法都应该有明确的访问修饰符,如 public,private,protected,或者默认(没有指定)。这决定了该方法从哪里可以被访问。
  • private:当一个类的成员被声明为private时,它只能被其本身访问,而不能被外部的类访问。这是访问权限最严格的修饰符。
  • protected:当一个类的成员被声明为protected时,它可以被其本身、相同包中的其他类以及不同包中的子类访问。
  • public:当一个类的成员被声明为public时,它具有最宽松的访问权限。它可以被任何其他类访问,无论这些类是否在相同的包中或是该类的子类。

首先包层次如下所示:

private只可以在类中访问:

protected同一包中访问:

Test类和User类属于同一包下可以访问:

EasyTest类在easy包下和User类不属于同一包下所以不可以访问:

public可以被其他的类任意访问:

不同包下也可以访问:

  1. 返回类型:方法应该明确声明其返回类型。如果方法不返回任何值,那么它应该声明为 void。返回的类型应该尽可能地精确,避免使用过于宽泛的类型,如 Object。
  2. 参数:方法的参数列表应该清晰明了,每个参数的类型和名称都应该明确。参数也应该使用驼峰命名法。
  3. 异常处理:方法应该清楚地声明它可能抛出的任何异常。这有助于调用此方法的代码理解可能发生的错误并适当处理。
  4. 注释:和方法相关的重要信息应该通过注释进行说明,包括方法的目的、参数的含义和返回值。注释应该使用JavaDoc格式。
  5. 方法体:方法体内部的代码应该简洁明了,避免冗长和复杂的代码。每个方法都应该尽量只做一件事情,这样有助于代码的重用和测试。

三、接口定义

1、接口命名

  • 接口名称应具有描述性,通常以able,ible或er结尾,例如Runnable,Serializable。
  • 使用大写字母开头的驼峰命名法,例如PublicInterface。
  • 避免使用Java关键字作为接口名称。

2、接口位置

  • 接口应该放在其使用者可以访问的位置。通常,这意味着接口应该放在一个包中,该包的名称反映了其用途。

3、方法命名

  • 接口方法应该是动词或动词短语,表示一个操作,例如start(),stop()。
  • 方法也应该使用驼峰命名法,并且首字母小写,例如public void myMethod();。

4、注释

  • 对接口和其方法进行充分的注释,以便其他开发者理解它们的用途。
  • 使用JavaDoc格式进行注释,以便可以通过工具生成API文档。

5、接口与实现分离

  • 接口不应包含任何具体的实现细节。这些细节应在实现接口的类中定义。

6、避免过于庞大

  • 避免创建过于庞大的接口,接口中的方法数量应适中。过于庞大的接口会使得实现类变得复杂和难以理解。

7、常量定义

  • 如果接口需要定义常量,则这些常量应该是公共的、静态的和最终的,通常这些常量都是大写字母,用下划线分隔单词,例如:public static final String CONSTANT_NAME = "value";

8、默认方法和静态方法

  • 在合适的情况下,可以使用默认方法和静态方法。默认方法可以在不破坏已有实现的情况下向接口添加新方法,而静态方法则可以提供与接口相关的工具性函数。

接口的定义 接口类中的方法和属性不要加任何修饰符号(public 也不要加)

⭐⭐⭐在JDK8以后接口中的方法也可以实现了,就是要在方法前面加一个default关键词。

实现接口使用implements,下面的图片中的代码有这么一行

Animal myDog = new Dog();

这一行是通过new Dog对象从而向上转型实现了Animal接口因为接口是不可以直接的被new出来的。

向上转型(Upcasting)和向下转型(Downcasting)是Java中两种重要的类型转换操作

1、向上转型(Upcasting)

  • 向上转型是将子类的引用转为父类的引用。
  • 由于子类对象可以当作父类对象来使用(子类是父类的扩展),这种转换是自动的,不需要使用任何特殊的语法。
  • 向上转型是安全的,不会丢失任何数据。示例:

                class Animal { }

                class Dog extends Animal { }

                Dog dog = new Dog();

                Animal animal = dog; // 向上转型, 自动完成

2、向下转型(Downcasting)

  • 向下转型是将父类的引用转为子类的引用。
  • 由于父类引用可能指向子类对象,也可能指向真正的父类对象,所以这种转换是不安全的,需要强制转换。
  • 在转换前,通常会使用instanceof操作符来检查是否可以安全地进行向下转型。示例:

                Animal animal = new Dog(); // 向上转型

                if (animal instanceof Dog) { // 检查是否可以安全地向下转型为Dog类型

                        Dog dog = (Dog) animal; // 向下转型, 需要强制转换

                        // ...

                }

四、变量定义

1、命名规范

  • 使用有意义的变量名,变量名应清晰地表达变量的用途。
  • 采用驼峰命名法,变量名首字母小写,例如 myVariable。
  • 对于多个单词组成的变量名,使用驼峰命名法,例如 mySecondVariable。

2、类型规范

  • 使用合适的数据类型,避免不必要的数据类型转换和浪费内存。
  • 在可能的情况下,优先使用基本数据类型而不是其包装类。

3、常量规范

  • 常量通常使用 static 和 final 关键字进行定义。
  • 常量名全部大写,单词之间使用下划线分隔,例如 MY_CONSTANT。
  • 常量不应被改变,因此在定义时应初始化。

五、static关键字

1、静态变量(类变量):

  • 使用static修饰的变量称为静态变量或类变量。
  • 它属于类,而不属于类的任何一个实例。也就是说,类的所有实例共享同一个静态变量。
  • 静态变量在类加载时初始化,仅在类加载时分配内存一次。
class Counter {  
    static int count = 0; // 静态变量  
  
    Counter() {  
        count++;  
        System.out.println(count);  
    }  
  
    public static void main(String args[]) {  
        Counter c1 = new Counter();  
        Counter c2 = new Counter();  
        Counter c3 = new Counter();  
    }  
}  
// 输出  
// 1  
// 2  
// 3

2、静态方法(类方法)

  • 使用static修饰的方法称为静态方法或类方法。
  • 静态方法可以直接通过类名来调用,不需要创建类的实例。
  • 静态方法可以访问静态数据成员并且可以更改静态数据成员的值。
class Example {  
    static int cube(int x) {  // 静态方法  
        return x * x * x;  
    }  
  
    public static void main(String args[]) {  
        int result = Example.cube(5); // 通过类名直接调用静态方法  
        System.out.println(result);  
    }  
}

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

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

相关文章

Baumer工业相机堡盟工业相机如何通过NEOAPI SDK设置相机的图像剪切(ROI)功能(C#)

Baumer工业相机堡盟工业相机如何通过NEOAPI SDK设置相机的图像剪切(ROI)功能(C#) Baumer工业相机Baumer工业相机的图像剪切(ROI)功能的技术背景CameraExplorer如何使用图像剪切(ROI)…

Netty使用SSL实现双向通信加密

最近项目有个需求,TCP服务器实现基于证书通信加密,之前没做过,花了一些时间调研,今天整理下。 SSL(Secure Sockets Layer 安全套接字协议) 1、原理 算法原理 简而言之就是非对称加密算法 私钥自己持有,公钥发给对方,对方在发送信息的时候使用公钥进行加密数据,当接收到…

C++-类和对象(2)

1.类的6个默认成员函数 如果一个类中什么成员都没有,简称为空类。 空类中真的什么都没有吗?并不是,任何类在什么都不写时,编译器会自动生成以下 6 个默认成员 函数。 默认成员函数:用户没有显式实现,编译…

【AI】DETR模型可视化操作

Detr作为目标检测的算法,不同于之前算法的就是注意力机制,注意力机制能够直观看出来模型对图像关注的点,这个直观到底怎么直观呢,我们只听别人说肯定是不行的,上手测试才是最好的方式,像论文中插图那样的使…

【网络流】最大流与Ford–Fulkerson算法

目录 一、引言1.1 网络流问题1.2 “流”的定义1.3 “割”的定义 二、最大流最小割2.1 最大流2.2 最小割2.3 最大流最小割定理2.4 最大流最小割定理证明 三、Ford–Fulkerson算法3.1 增广路径3.2 剩余图3.3 算法代码3.4 FordFulkerson Demo 一、引言 1.1 网络流问题 网络流问题…

【教学类-43-13】 20240103 (4宫格数独:错误版:768套) 不重复的基础模板数量:768套

作品展示:——4宫格 768套不重复模板(64页*12套题) 有错误,实际数量小于768套 背景需求: 测试4宫格数独基础模板有几种。 写个程序,验算是不是真的是乘阶法的288种。 代码展示: 768套4宫格题…

AI原生应用开发“三板斧”亮相WAVE SUMMIT+2023

面对AI应用创新的风口跃跃欲试,满脑子idea,却苦于缺乏技术背景,不得不望而却步,这曾是许多开发者的苦恼,如今正在成为过去。 12月28日,WAVE SUMMIT深度学习开发者大会2023在北京举办。百度AI技术生态总经理…

【Java 基础】-- 实例化

1、定义 创建对象的过程就叫实例化。这个过程中会在堆中开辟内存,将一些非静态的方法,变量存放在里面。在程序执行的过程中,可以创建多个对象,既多次实例化。每次实例化都会开辟一块新的内存。 2、实例化的几种方法 new 关键字创…

STM32学习笔记十七:WS2812制作像素游戏屏-飞行射击游戏(7)探索动画之故事板,复杂动画

要让物体沿着路径移动,必须同时修改X/Y两个值,用两个连续插值动画行不行? 在单片机这种单线程设备,两个TICK会前后脚进行修改,具有相同的时间跨度,所以似乎也是可以的。但是在支持多线程的设备&#xff0c…

【CVPR2023】使用轻量 ToF 传感器的单目密集SLAM的多模态神经辐射场

目录 导读 本文贡献 本文方法 轻量级ToF传感器的感知原理 多模态隐式场景表示 时间滤波技术 实验 实验结果 消融实验 结论 未来工作 论文标题:Multi-Modal Neural Radiance Field for Monocular Dense SLAM with a Light-Weight ToF Sensor 论文链接&am…

Java程序设计阶段测试1

一、单选题(共15题; 共30.0分) 2.0分 1、以下哪个是Java应用程序main方法的有效定义? A.public static void main(); B.public static void main( String args ); C.public static void main( String args[] ); D.public static boolea…

交换机02_共享式交换式

1、共享式网络 早期的以太网是共享式网络,它是由集线器(HUB)相连,由一个HUB相连了两台主机,形成一个冲突域也称广播域。 (1)相关名词解释 集线器 HUB中心的意思,集线器就是对接收…

VINS-MONO拓展1----手写后端求解器,LM3种阻尼因子策略,DogLeg,构建Hessian矩阵

文章目录 0. 目标及思路1. 非线性优化求解器2. 基于VINS-MONO的Marginalization框架构建Hessian矩阵2.1 estimator.cpp移植2.2 solve.cpp/preMakeHessian()2.3 solve.cpp/makeHessian() 3. solve.cpp/solveLinearSystem()求解正规方程4. 更新状态5. 迭代求解6. EVO评估结果7. 待…

drf知识--10

接口文档 # 后端把接口写好后: 登录接口:/api/v1/login ---> post---name pwd 注册接口 查询所有图书带过滤接口 # 前后端需要做对接,对接第一个东西就是这个接口文档,前端照着接口文档开发 公司3个人&#xff…

LaTeX语法、工具及模板大全(持续更新ing...)

诸神缄默不语-个人CSDN博文目录 我之前把Markdown和LaTeX的语法写在一个博文里了,但是现在感觉还是应该拆开来比较合适,因为LaTeX太复杂了…… LaTex核心其实是套模板,但是为了套好模版,也需要学习一些具体的语法。 文章目录 1.…

14 简约登录页

效果演示 实现了一个简单的登录表单的样式,包括背景颜色、边框、字体颜色、字体大小、字体粗细、输入框样式、提交按钮样式等。当用户在输入框中输入内容时,输入框下方的提示文字会动态地变化,以提示用户输入正确的信息。当用户点击提交按钮时…

广播及代码实现

广播(Broadcast)是一种网络通信方式,它允许一台设备向网络中的所有其他设备发送消息。广播通常用于在网络上传递一些信息,让所有设备都能接收并处理。在广播中,通信的目标是整个网络而不是特定的单个设备。 向子网中…

电风扇目标检测数据集VOC格式1100张

电风扇的全方位介绍 一、功能特性 电风扇作为一种晋及化的家用电器,其主要功能是利用电机驱动扇叶旋转,从而产生风力,用干调节室内空气流通,达至降温、通风和改善室内环境的目的。此外,现代电风扇还具备定时、遥控、…

踩坑记录-安装nuxt3报错:Error: Failed to download template from registry: fetch failed;

报错复现 安装nuxt3报错:Error: Failed to download template from registry: fetch failednpx nuxi init nuxt-demo 初始化nuxt 项目 报错 Error: Failed to download template from registry: fetch faile 解决方法 配置hosts Mac电脑:/etc/hostswin电…

vue本地打包预览

1、项目打包 npm run build2、安装serve npm install -g serve3、在项目的 dist 文件运行命令行 serve 4、运行如下在浏览器打开即可