日撸 Java 三百行： DAY3 基本If语句

0.主题

今天的主题大致包含三块内容

• 掌握基本if语句的使用
• 了解方法调用
• 对方法头部的规范注释

通过实现一个求绝对值的小程序来过一遍这三个板块。

1.If语句

求一个数绝对值的逻辑很简单，即当值大于等于0时返回它本身，否则返回它的相反数。首先将程序代码附上。

package basic;

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 value
		tempNumber1 = 5;
		
		if( tempNumber1 >= 0 ) {
			tempNumber2 = tempNumber1;
		} else {
			tempNumber2 = -tempNumber1;
		} // Of it
		
		System.out.println("The absolute of " + tempNumber1 + " is " + tempNumber2 );
		
		//Try a negative value
		tempNumber1 = -3;
		
		if( tempNumber1 >= 0 ) {
			tempNumber2 = tempNumber1;
		} else {
			tempNumber2 = -tempNumber1;
		} // Of it
		
		System.out.println("The absolute of " + tempNumber1 + " is " + tempNumber2 );
		
		//Now we use a method/function for this purpose.
		tempNumber1 = 6;
		System.out.println("The absolute of " + tempNumber1 + " is " + abs( tempNumber1 ) );
		tempNumber1 = -8;
		System.out.println("The absolute of " + tempNumber1 + " is " + abs( tempNumber1 ) );
	} // Of main
	
	/**
	 **************
	 * The absolute value of the given parameter.
	 * 
	 * @param paraValue The given value.
	 **************
	 */
	public static int abs( int paraValue ) {
		
		if( paraValue >= 0 ) {
			return paraValue;
		} else {
			return -paraValue;
		} // Of it
	} // Of abs
} // Of class IfStatement

if语句的基本使用比较简单，故不再多说，程序执行结果如下。

 2.方法（函数）调用

方法调用可以有效的实现代码复用，同时使得程序看起来更整洁美观。正如上文代码所示，没有代码复用时，每求一个数的绝对值就得重新写次代码，既给程序员带来了额外的工作量，又导致代码冗长不美观。

对于需要多次使用的功能，我们可以将它封装成一个方法，每次使用时只需要调用方法即可，求绝对值功能被封装如下。

/**
 **************
 * The absolute value of the given parameter.
 * 
 * @param paraValue The given value.
 **************
 */
public static int abs( int paraValue ) {
		
	if( paraValue >= 0 ) {
		return paraValue;
	} else {
		return -paraValue;
	} // Of it
} // Of abs

3.方法（函数）头部注释

封装了方法之后，我们需要能够尽快的识别每个方法所实现的功能是什么，各个参数的含义是什么，方法的返回值是什么。毕竟方法封装好了是拿来用的嘛，要是半天看不懂一个方法是在干嘛，那对于工作效率的影响可就不太好了。

要达成以上目的，除了给方法取一个好的，一眼能看出其功能的名字之外，还要在头部添加规范的注释。

java提供了一种以/**开头，以/*结尾的注释，可以用来自动地生成文档。输入/**后敲下回车，就会自动的生成有良好规范的头部注释格式了。通常在方法头部的注释中需要标明几类信息

• 对方法实现功能的概述
• @param变量描述，用于描述方法参数的含义
• @return描述，用于描述方法返回值的含义
• @throws类描述，用于表示这个方法有可能抛出异常

以上文给出的代码为例，abs( )方法的头部注释简洁地注明了该方法的功能及参数含义，有助于快速的了解方法功能，增强代码可读性。