Java注释--单行注释、多行注释、文档注释

Java注释–单行注释、多行注释、文档注释

单行注释和多行注释

语法格式

//单行注释
//单行注释
//注释内容/*
这里可以放置多行注释
多行注释的内容
Java真的学起来有意思！！
*/

举例：

//这是一段用于测试注释的代码
public class Annotation_test{public static void main(String[] args){//下面的语句将原封不动输出：Hello Annotation!!System.out.println("Hello Annotation!!");}
}

编译和执行：

可见，注释不改变代码的输出

总结来说，注释有以下这些作用：
（1）增强可读性，注释起到解释说明的作用，不论是自己还是别人，看了注释，都会更明确代码的逻辑
（2）便于调试。发现有问题的代码，可以直接注释掉，便于排除代码中的障碍

其实我本人最讨厌什么注释都不写的代码，写注释真的是一个非常良好的习惯！

文档注释

举例：

/**
@author bones
@version 1.0
这是关于java基础的文档注释的 代码，非常好理解
*/
public class Anno_test2{public static void main(String[] agrs){System.out.println("Hello 文档注释！！");}/**@param name 姓名@param age  年龄@param height 身高*/public boolean isPickSno(String name,int age,double height){if(age>0){return true;}else{return false;}}
}

文档注释的语法格式：

/**
文档注释的内容。。。。
*/

文档注释放在整个文件前面，可以说明作者、版本、日期、包名等信息，文档注释放在一个方法前面，可以说明形式参数等含义等。

同时文档注释可以配合javadoc.exe生成一套类似于关于这个自定义类的网页API

例如：

查看需要点击index.html文件：

跟Java的API很类似：

Java注释--单行注释、多行注释、文档注释相关推荐

JavaSE之注释规范、文档注释及注解
Java中的注释不会出现在可执行程序中,有三种标记注释的方式:(1)//:单行注释:(2)/*--*/:多行注释:(3)/**--*/:文档注释. 一.注释可以帮助我们更清晰地阅读代码,了解代码.在阿 ...
idea html注释,IntelliJ IDEA文档注释
IntelliJ IDEA 文档注释 IntelliJ IDEA 为创建文档注释提供了方便的功能. 您的源代码中的文档注释可用于快速文档查找并通过按 Ctrl + Q 打开以进行审阅. 在 Java ...
java注释【单行注释，多行注释，文档注释】
文章目录一.java注释类型二.详细操作代码生成文档到生成的目录下面查看一.java注释类型单行注释多行注释文档注释注意:注释过的语句不会被java虚拟机执行二.详细操作 1.单 ...
java接口注释_Java的注释和API文档
Java 语言的注释一共有三种类型: 单行注释多行注释文档注释一.单行注释和多行注释单行注释就是在程序中注释一行代码,在 Java 语言中,将双斜线(//)放在需要注释的内容之前就可以了 : ...
让别人和自己看懂自己的程序代码？一文掌握Java单行多行、文档注释以及注解(Annotation)超详细的理解使用，IDEA注释注解快捷键和模板，提高程序代码更有可读性
文章目录单行和多行注释文档注释(Java特有) Annotation(注解)的理解常见的Annotation示例 IDEA注释注解快捷键及模板自定义 Annotation JDK 中的元注解 ...
【Java】浅谈JavaDoc文档注释
JavaDoc文档注释文档注释 JavaDoc标记文档注释示例基于Eclipse IDE的JavaDoc实战后记文档注释我们知道,Java有三种注释: 单行注释:// 多行注释:/* */ ...
java文档注释报错,java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...
java文档注释的作用示例（用cmd命令提示符窗口）
前提是已经配置了java相关的的环境变量 java语言在c语言单行注释.多行注释的基础上加了文档注释. 1.1文档注释的使用: 注释内容可以被jdk提供的工具Javaddoc所解析,生成一套以 ...
java文档注释生产api没有注释_如何使用javadoc命令生成api文档，文档注释
/** * 计算器工具类 * * @62616964757a686964616fe78988e69d8331333365646332author GaoHuanjie * @version V1.0 ...
JAVA文档注释规范
JAVA比较规范的文档注释 ...

Java注释--单行注释、多行注释、文档注释

Java注释–单行注释、多行注释、文档注释

单行注释和多行注释

文档注释

Java注释--单行注释、多行注释、文档注释相关推荐

最新文章

热门文章