day03

最新推荐文章于 2024-09-15 19:46:31 发布

今年元夜时

最新推荐文章于 2024-09-15 19:46:31 发布

阅读量587

点赞数 1

文章标签： java 开发语言后端

本文链接：https://blog.csdn.net/qq_43571222/article/details/122822688

版权

本文介绍了作者在学习Java的第三天遇到的主要内容，包括if语句的使用、函数调用以及Java注释规范。特别强调了文档注释的重要性，如@author、@param等标记，并提供了代码示例展示如何使用这些注释。文章指出良好的代码注释可以提高代码的可读性。

摘要由CSDN通过智能技术生成

day 03

1. Background

今天是学习java的第三天，主要任务是学习if语句的用法，以及函数的调用和注释的规范。

2. Description

if then else语句的用法和C语言的差别不大，如果有C语言基础，理解起来则无太大困难。函数的调用也是同理。

今日让我觉得麻烦的点则是java中的注释规范。

由于本人非科班出身，没有受过系统性的学习，代码风格本身就是大杂烩。我之前写的代码一直以来都是只有我一个人看，我的标准是能跑、满足需求就行，所以翻阅我以前写的代码，几乎没有写过注释。毕竟自己不可能看不懂自己的代码，所以也没有写注释的必要。

2.1 注释

单行注释：// 即可，和C语言以及其它编程语言一样。（IDE中选定要注释的内容，然后按下 Ctrl 和 /，即可快速注释）
多行注释：以 /* 开头，以 */ 结尾。和C语言也是完全一样
文档注释

文档注释是今日学习的重点，编写任何的代码，都少不了编写程序的文档，怎么高效的编写文档内容，并且文档的内容能够随着版本的更新进行更新。Java 语言中有一种注释规则，就是文档注释类型。对于文档注释的内容，是可以通过 Java 内置命令行工具 javadoc 生成对应的文档内容的。并且Java 的 API 也是基于这种机制生成的文档。

使用文档注释的方式以 /** 开头 */ 结尾。包含在这之内的内容就是文档注释的内容。而且针对文档注释有一系列的标记。该注释一般会放在类、方法、变量、常量上。

常用的有：
- 类标记：@author代表作品的作者
  
  @since从哪个版本开始支持该类的功能
  
  @version当前版本
  
  @see表示参考的类或方法
- 方法标记：@param参数的描述信息
  
  @return当前方法返回的描述信息
  
  @exception异常的描述信息，与throws对应的异常
  
  @throws描述该方法可能抛出的异常信息，和 @exception 联合使用
文档注释在VScode的注释中输入@会自动弹出

3. Code

package basic;

/**
 * The usage of the if statement
 * 
 * @author Fan Min minfanphd@163.com
 * @learner Leo Liu lyx1443807042@163.com
 */

public class day03 {
    
    /**
     **************************
     * The entrance of the program.
     * 
     * @param args not used now.
     * *************************
     */
    public static void main(String[] args) {
        int tempNumber1, tempNumber2;

        // Try a positive
        tempNumber1 = 5;

        if (tempNumber1 >= 0) {
            tempNumber2 = tempNumber1;
        } else {
            tempNumber2 = -tempNumber1;
        } // Of if

        System.out.println("The absolute value of " + tempNumber1 + " is " + tempNumber2);

        // Try a negative value
        // Lines 37 through 41 are the same as lines 25 through 29
        tempNumber1 = -3;

        if (tempNumber1 >= 0) {
            tempNumber2 = tempNumber1;
        } else {
            tempNumber2 = -tempNumber1;
        } // Of if

        System.out.println("The absolute value of " + tempNumber1 + " is " + abs(tempNumber1));

        // Now we use a method/function for this purpose.
        tempNumber1 = 6;
        System.out.println("The absolute value of " + tempNumber1 + " is " + abs(tempNumber1));
        tempNumber1 = -8;
        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.
     ****************************
     */
    public static int abs(int paravalue) {
        if (paravalue >= 0) {
            return paravalue;
        } else {
            return -paravalue;
        } // Of of
    } // Of abs
} // Ofclass IfStatement