【愚公系列】2023年07月 Java教学课程 004-Java语言三种注释

文章目录

• 前言
• 一、单行注释
• 二、多行注释
• 三、文档注释
• 总结

前言

注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码。注释是编写程序时，写程序的人给一个语句、程序段、函数等的解释或提示，能提高程序代码的可读性.

一、单行注释

以“//”开头，后面接要说明的内容。使用范围没有什么规定，比如开发前，我们可以用单行注释把思路写下来，开发后，可以把局部说明写下来供后人参考。

比如我们一般在实体类的属性后面用单行注释注明（如下）：

public class User implements Serializable{private String id;// 自增型IDprivate String username;// 用户名private String password;// 用户密码}

二、多行注释

又称为块注释，可以把一部分代码块注释掉，使用范围不太清楚，但是我一般都拿来注释代码。

比如我们要注释一个判断的一部分，用多行注释就很方便（如下）：

/* 我是多行注释 */
if (null != password ) {return "ok";
}

三、文档注释

文档注释用得比较少，但是很方便，尤其是他自带的那些标签，我个人的建议是加在认为有必要加注释的方法、类、接口、全局变量等上面，因为在Eclipse中把鼠标移动到方法上，会显示出写了文档注释的说明，很实用（如下）：

import java.io.*;/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {/*** This method returns the square of num.* This is a multiline description. You can use* as many lines as you like.* @param num The value to be squared.* @return num squared.*/public double square(double num) {return num * num;}/*** This method inputs a number from the user.* @return The value input as a double.* @exception IOException On input error.* @see IOException*/public double getNumber() throws IOException {InputStreamReader isr = new InputStreamReader(System.in);BufferedReader inData = new BufferedReader(isr);String str;str = inData.readLine();return (new Double(str)).doubleValue();}/*** This method demonstrates square().* @param args Unused.* @return Nothing.* @exception IOException On input error.* @see IOException*/public static void main(String args[]) throws IOException{SquareNum ob = new SquareNum();double val;System.out.println("Enter value to be squared: ");val = ob.getNumber();val = ob.square(val);System.out.println("Squared value is " + val);}
}

总结

文档注释相关表格

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！