ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

【Java基础知识】方法与注释

【Java基础知识】方法与注释

文章目录

  • 一、方法详解
    • 1.方法的定义
    • 2.方法的定义格式
    • 3. 方法的调用方式
    • 4.方法的多种形式
      • (1)无参数无返回值
      • (2)有参数有返回值
      • (3)其他组合形式
  • 二、代码注释
    • 1. 注释的三种形式
      • (1)单行注释
      • (2)多行注释
      • (3)文档注释
    • 2. 注释的使用规范
    • 3. 利用 AI 工具生成注释

摘要:本文系统梳理了 Java 中方法与代码注释两大基础知识点。方法部分从定义出发,讲解方法的封装与复用价值,拆解访问修饰符、静态修饰符、返回值类型、方法名、参数列表与方法体六要素,并结合求和、打印等示例演示方法的调用方式,最后归纳无参数无返回值、有参数有返回值等四种组合形式。注释部分介绍单行注释、多行注释与文档注释三种写法,总结注释使用规范,并演示如何借助通义灵码等 AI 工具自动生成注释。全文示例均可直接运行,适合 Java 初学者快速建立方法与注释的完整认知。

一、方法详解

1.方法的定义

方法是一段封装了特定功能的可重用代码块,它能够接收输入数据、进行处理并返回结果(也可以无返回结果)。方法的核心作用是实现代码的模块化和复用。

例:(实现求和功能)

publicstaticintsum(inta,intb){returna+b;}

上述代码通过sum()方法封装了两个整数相加的功能


例:(打印功能)

publicstaticvoidprintHelloWorld(){System.out.println("hello world");System.out.println("hello world");System.out.println("hello world");}

上述代码通过printHelloWorld()方法封装了重复打印 “hello world” 的功能


2.方法的定义格式


一个完整的方法定义包含以下几个部分:

  • 访问修饰符(如public、private、protected、default)
    • public:公共,同包、不同包、子类全能用。
    • protected:受保护,同包内及不同包的子类可访问。
    • default(不写修饰符):包私有,仅同包内可访问。
    • private:私有,只能本类内部访问。
  • 静态修饰符(如static,可选)
    • 静态方法:属于类本身,调用时不用new对象,通过类名.方法名()调用。
    • 非静态方法(实例方法):属于对象,必须通过new创建对象后调用。
  • 返回值类型(方法返回结果的数据类型,无返回值时用void)
    • 基本数据类型(如int、double、boolean)或引用类型(如String、List、自定义类)。
    • void表示不返回任何值。
  • 方法名(遵循驼峰命名法,首字母小写,应见名知意)
    • 如getSum、calculateAverage、printUserInfo。
  • 参数列表(方法接收的数据,可空)
    • 格式:(数据类型 参数1, 数据类型 参数2, ...)。
    • 可为空:()。
  • 方法体(实现功能的代码块,用{}包裹)
    • 包含具体的执行语句。
    • 若有返回值,必须使用return语句返回对应类型的数据。
    • void方法可省略return,或使用return;提前结束。

示例:拆解一个完整方法定义

// 访问修饰符 静态修饰符 返回值类型 方法名(参数列表)publicstaticintcalculateSum(intnum1,intnum2){// 方法体开始intsum=num1+num2;returnsum;// 返回结果// 方法体结束}

例:求和方法


3. 方法的调用方式

方法定义后不会自动执行,必须在其他方法(通常是main方法)中调用才能执行,
调用格式:方法名称(参数列表)。

完整演示方法的执行(求和方法)

publicclassDemo{//main方法publicstaticvoidmain(String[]args){//目标,掌握方法的定义与调用intsum=getSum(1,2);System.out.println("和为:"+sum);System.out.println("------------");//同一个方法的不同使用intsum2=getSum(3,4);System.out.println("和为:"+sum2);}//求两个任意整数的和(getSum方法)publicstaticintgetSum(inta,intb){returna+b;}}

main方法是是程序入口,它天生就是 static。
Java 规定:
static 方法里,只能直接调用其他 static 方法 / 变量。所以求和方法也必须是 static

4.方法的多种形式


根据是否需要接收参数和返回结果,方法可以分为以下几种形式:

(1)无参数无返回值

当方法既不需要接收数据,也不需要返回结果时,使用void作为返回值类型,参数列表为空。

例:打印三行Hello World

publicclassDemo{publicstaticvoidmain(String[]args){printHelloWorld();}//无参数、无返回值publicstaticvoidprintHelloWorld(){System.out.println("Hello World!");System.out.println("Hello World!");System.out.println("Hello World!");}}

(2)有参数有返回值

当方法需要接收数据进行处理,并返回处理结果时,需要指定参数列表和返回值类型。

例2:生成指定位数的数字验证码’

(只需掌握方法的定义格式)

publicclassDemo{publicstaticvoidmain(String[]args){System.out.println(getCode(4));//获取4位验证码System.out.println(getCode(5));//获取5位验证码}//有参数、有返回值的方法publicstaticStringgetCode(intn){Stringcode="";for(inti=0;i<n;i++){intnumber=(int)(Math.random()*10);code+=number;}returncode;}}

(3)其他组合形式

  • 有参数无返回值:接收数据处理,但不需要返回结果
  • 无参数有返回值:不需要接收数据,但需要返回结果


二、代码注释

在 Java 开发中,合理使用注释是良好的编程习惯,它具有以下重要作用:

  • 提高代码可读性:帮助自己和其他开发者理解代码逻辑
  • 便于维护:当需要修改代码时,注释可以快速指引核心逻辑
  • 辅助开发:现代 AI 开发工具(如通义灵码)可以根据注释自动生成代码

1. 注释的三种形式

(1)单行注释

使用//开头,注释从//到本行结束的内容。

// 这是一个单行注释,用于解释单行代码intage=18;// 定义年龄变量并赋值

(2)多行注释

使用/* 开头,*/结尾,可注释多行内容

/* * 这是一个多行注释 * 可以用来解释一段代码的功能 * 或者暂时注释掉不需要执行的代码块 */inta=10;intb=20;intc=a+b;

(3)文档注释

使用/**开头,*/结尾,主要用于生成 API 文档,通常放在类、方法或字段的前面。

/** * 计算器工具类 * 提供基本的加减乘除运算 */publicclassCalculator{/** * 计算两个整数的和 * @param a 第一个整数 * @param b 第二个整数 * @return 两个整数的和 */publicstaticintadd(inta,intb){returna+b;}}

2. 注释的使用规范

  • 文档注释通常用于注释类、接口、方法和重要字段
  • 多行注释常用于注释代码块或复杂逻辑
  • 单行注释常用于注释单行代码或简单说明
  • 注释内容应当简洁明了,准确反映代码意图
  • 避免注释显而易见的代码(如int i = 0; // 定义i并赋值0)

3. 利用 AI 工具生成注释


现代开发工具(如通义灵码、IntelliJ IDEA 的 AI 助手等)可以帮助自动生成注释,提高开发效率。

注意:注释不会影响程序的执行,编译器会忽略所有注释内容。良好的注释习惯是优秀程序员的基本素养。

返回列表