java注释工具_Java注释和javadoc工具

本篇文章分为两部分：注释(基础)和注释(进阶)。在注释(基础)部分，主要讲述注释的概念、类别、写注释的规范、细节和作用；在注释(进阶)部分，主要讲使用javadoc开发工具生成一个开发者文档。

内容概览：

注释基础注释的概念

注释的类别

写注释的规范

注释要注意的细节

注释的作用注释进阶文档注释与多行注释的区别：开发者文档

使用javadoc开发工具生成一个开发者文档

1、注释(基础)

1.1、注释的概念

注释就是使用文字对程序的说明，注释是写给程序员看的，编译器会忽略注释的内容的。

1.2、注释的类别

第一种： 单行注释。   // 注释的内容

第二种： 多行注释。   /* 注释的内容  */

第三种： 文档注释.    /** 注释的内容  */　文档注释也是一个多行注释。

1.3、写注释的规范

一般单行注释是位于代码的右侧，多行注释与文档注释一般是写在类或者方法的上面的。

1.4、注释要注意的细节

单行注释可以嵌套使用，多行注释是不能嵌套使用的

1.5、注释的作用

1. 使用文字对程序说明

2. 调试程序：有时候程序比较复杂，需要注释掉一部分内容，来帮助查找出错的地方

2、注释(进阶)

有一种说法是软件 =  数据 + 指令 + 文档(使用者文档+ 开发者文档)

即软件由数据、指令和文档组成，而文档包括使用者文档和开发者文档。其中，开发者文档可以借由Java语言的文档注释和javadoc工具来生成。

2.1、文档注释与多行注释的区别：开发者文档

多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。

2.2、使用javadoc开发工具生成一个开发者文档

2.2.1、javadoc工具的使用格式javadoc -d 存放文档的路径   java的源文件

2.2.2、使用javadoc工具要注意细节

1.如果一个类需要使用javadoc工具生成一个软件的开发者文档，那么该类必须使用public修饰。

2.文档注释注释的内容一般都是位于类或者方法的上面的。

2.2.3、作者和版本信息

在源代码的文档注释中加入“@author XXX同学”和“@version 1.0”

在使用javadoc工具时，使用如下命令：javadoc -author -version -d 存放文档的路径　java的源文件

2.3、实际操作

在D:\rk文件夹下，新建一个MyTest.java文件，内容如下：/**这是我的一个测试类

*@author RK

*@version 1.0

*/

public class MyTest

{

/**

*这里是MyTest类的入口函数main

*@param args 这是需要输入的参数

*/

public static void main(String[] args)

{

System.out.println("Hello World!");

}

}

在控制台中，切换到D:\rk目录下，使用如下命令：javadoc -author -version -d d:\rk\mydoc MyTest.java

查看结果：

思维导图

如果遇到Exception in thread main java.lang.NoClassDefFoundError，可能是这三方面原因：1、类名(大小写问题);2、包名(是否在包里面)和3、Classpath的设置问题。