当前位置：首页 > news >正文

【日撸 Java 三百行】Day 3（注释，基本if语句，函数调用）

news 来源：原创 2025/5/7 7:30:15

Day 3：注释，基本if语句与函数

一、关于头部注释

二、基本 if 语句

三、函数调用

小结

Day 3：注释，基本if语句与函数

Task：

if then else.
方法（函数）调用: 增加代码的复用性.
方法（函数）头部规范的注释, 是后期生成文档的基础.

一、关于头部注释

1. 作者相关信息

        代码注释向阅读者说明代码除了内在逻辑信息之外其余信息，包括辅助理解与说明编写者等内容。一个完善的代码开头总却少不了作者信息。
        为了避免每次开始自己的代码时都要手动添加信息，eclipse 为我们提供了一种方便设置。这一步作者在Day 1的环境配置中已经完成（参考博文：【日撸 Java 三百行】Day 1-2（环境搭建与基本运算）-CSDN博客），这里单独挑出这一部分重新说明一下。
        （1）找到 Window → Preferences，在左上角的输入框中输入Code Templates，找到Java → Code Style → Code Templates，在Code Templates视窗中选择Code, 配置代码模板（即创建类时，自动生成注释）

（2）选择Code → New Java files 配置创建类时的注释模板（即自动生成注释），双击New Java files，在${filecomment}
${package_declaration} 和 ${typecomment} ${type_declaration} 之间添加如下代码到你的Pattern中：

/**** @版权 : Copyright (c) 2017-2018 *********公司技术开发部* @author: 作者姓名(一般是写姓名的拼音)* @E-mail: 邮箱* @版本: 1.0* @创建日期: ${date} ${time}* @ClassName ${type_name}* @类描述-Description:  ${todo}(这里用一句话描述这个方法的作用)* @修改记录:* @版本: 1.0*/

操作示意图如下：

其中，可以利用说明符“${}”支持相关的信息宏定义，当然，个人项目按照自己的习惯就好，但是，若自己的编写内容要在一个标准化环境下或者一个项目组中应用的话，还是以组内标准要求为主。

完成以上工作后，开始创建今天的项目，可以发现，这里已经自动生成作者信息了。

2. 函数及类的头部注释

（1）找到 Window → Preferences，在左上角的输入框中输入Code Templates，找到Java → Code Style → Code Templates，在Code Templates视窗中选择Comments,配置注释模板（即 alt+shift+j 手动添加注释，提示：1、将光标放到类名上，按下快捷键 alt+shift+j 会添加类的注释。2、将光标放到方法名上，按下快捷键 alt+shift+j 会添加方法的注释）

/**** @版权 : Copyright (c) 2017-2018 *********公司技术开发部* @author: 作者姓名(一般是写姓名的拼音)* @E-mail: 邮箱* @版本: 1.0* @创建日期: ${date} ${time}* @ClassName ${type_name}* @类描述-Description:  ${todo}(这里用一句话描述这个方法的作用)* @修改记录:* @版本: 1.0*/

（2）选择Comments → Types 配置类的注释模板（即手动添加注释），双击Types，添加如下代码到你的Pattern中：

/*** @Title: ${enclosing_method}* @Description: ${todo}(这里用一句话描述这个方法的作用)* ${tags}    參數描述* @return ${return_type}  返回类型* @throws*/

具体操作示意图如下：

配置类注释模板：

配置方法注释模板：

        完成了之后，我们试着创建一个main函数，然后下面两种方式创建我们的注释：
        第一种，在函数上方输入/**，然后回车即可快速生成注释
请添加图片描述
        第二种是光标选中我们的函数名，然后快捷Shift+Alt+J 可快速生成

二、基本 if 语句

这里使用的绝对值计算来验证条件语句，这是因为绝对值计算可以展开为简单的分段函数，符合if-else语句的使用环境。
代码如下：

package basic;/*** The usage of sth.** @author: Changyang Hu joe03@foxmail.com* @date created: 2025-05-06*/
public class IfStatement {/************************ The entrance of the program.* * @param args Not used now.**********************/public static void main(String args[]) {int tempNumber1, tempNumber2;// Try a positive valuetempNumber1 = 5;if (tempNumber1 >= 0) {tempNumber2 = tempNumber1;} else {tempNumber2 = -tempNumber1;} // Of ifSystem.out.println("The absolute value of " + tempNumber1 + " is " + tempNumber2);// Try a negative value// Lines 36 through 42 are the same as Lines 24 thorough 30tempNumber1 = -3;if (tempNumber1 >= 0) {tempNumber2 = tempNumber1;} else {tempNumber2 = -tempNumber1;} // Of ifSystem.out.println("The absolute value of " + tempNumber1 + " is " + tempNumber2);}// Of main
}// Of class IfStatement

运行结果如下：

三、函数调用

将功能封装为函数，能够有效的提高代码的可阅读性以及结构性。观察上述示例，我们发现我们可以将绝对值的判断封装为一个 abs() 函数。
更改后，代码如下：

package basic;/*** The usage of sth.** @author: Changyang Hu joe03@foxmail.com* @date created: 2025-05-06*/
public class IfStatement {/************************ The entrance of the program.* * @param args Not used now.**********************/public static void main(String args[]) {int tempNumber1, tempNumber2;// Now we use a method/function for this purpose.tempNumber1 = 7;System.out.println("The absolute value of " + tempNumber1 + " is " + abs(tempNumber1));tempNumber1 = -9;System.out.println("The absolute value of " + tempNumber1 + " is " + abs(tempNumber1));}// Of main/************************ The absolute value of the given parameter.* * @param paraValue The given value.* @return The absolute value of the paraValue.**********************/public static int abs(int paraValue) {if (paraValue >= 0) {return paraValue;} else {return -paraValue;} // Of if}// Of abs
}// Of class IfStatement

运行结果如下：

由于 Java 是延伸于 C，故其构造函数的方式与 C++ 几乎一致，回顾之前的 C++ 相关知识：
【C++】第3章类和对象进阶_第三章类和对象进阶-CSDN博客

需要着重注意的点是：

函数使用过程中，注意函数头部的关键字使用。这里对函数（方法）名加以“static”关键字，使得函数修饰为静态方法，这使得无需本类的对象即可调用此方法。相关定义与C++类似。
其中“public”访问修饰符说明了方法的使用权限，这里可类比C++的类中方法的构造，是最低的限制权限，基本上是任何类，子类，包都可以访问。基本上来说，定义一个普通函数都是以public static作为基本的修饰。

具体权限可以参考下图：