学习笔记：day02 Java中的三种注释

2021-07-06 10:32:30 阅读：172 来源： 互联网

注释

注释不会被当作代码执行，只是对代码的一个解释，给看代码的人看，好的注释会提高代码易读性

书写注释是一个非常好的习惯

1.单行注释

单行注释顾名思义，即只有一行的注释，使用//开头，单行注释只能包含一行注释文本

//输出Hello World
System.out.println("Hello World");

2.多行注释

以/*开头，以*/结尾，中间可包含多行注释文本

/*
这
是
多
行
注
释
*/

3.文档注释

Javadoc是用来生成api文档，以/**开头，以*/结尾

参数

命令	说明
@author	作者名
@version	版本号
@since	指明需要最早使用的jdk版本
@param	参数名
@return	返回值情况
@throws	异常抛出情况

/**
 * @author aji <---作者名
 * @version 1.0  <---版本号
 * @since 1.8 <---需要最早的jdk版本号
 */
public class JavaDoc {
    /**
     *
     * @param name  <---参数
     * @return  <---返回值
     * @throws Exception <---异常抛出
     */
    public String test(String name) throws Exception{
        return name;
    }
}

生成步骤

1.使用cmd命令行生成

在Java源文件目录下输入

然后目录下会出现很多文件，点开index.html

2.使用idea生成

点击tools打开generateJavadoc

在这里插入图片描述

1.选择是整个项目还是模块还是单个文件

2.文档输出路径

3.Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

4.传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题”

在这里插入图片描述

点击ok就可以生成了

标签：Java,day02,笔记,生成,注释,单行,文档,World
来源： https://www.cnblogs.com/ajiblog/p/14975743.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9