Java注释及其规范

Java具有三种注释：

 1.单行注释

        使用场景：类的属性，方法中代码的注释

        1.使用在类的属性上

public class Book {private String bookName;//图书名称private String author;//图书作者}

        2.使用在方法中对代码进行解释

public void showBook(String bookName,String author){//显示图书的信息System.out.println("bookName:"+bookName+",author:"+author);}

 2.多行注释

         使用场景：对类注释,对方法注释 

         1.对类进行注释

/* * 图书类 */public class Book{  ....}

        2.对方法进行注释

/* * 无参构造方法 */public Book(){}

 3.文档注释

     和单行注释和多行注释不同的是，文档注释可以生成html格式的javadoc文档，所以如果确定使用文档注释的话，建议在类的属性、方法、类的注释上都使用文档注释（方法中可以使用单行注释对方法中的代码进行解释）

/** * 图书类 * @author Administrator * @version 1.0 */public class Book {/** * 图书名称 */private String bookName;/** * 图书作者 */private String author;/** * 无参的构造方法 */public Book(){}/** * 全参数的构造方法  * @param bookName 图书名称 * @param author 图书作者 */public Book(String bookName,String author){this.bookName=bookName;this.author=author;}/** * 获取图书名称 * @return 图书名称 */public String getBookName() {return bookName;}/** * 设置图书名称 * @param bookName 图书名称 */public void setBookName(String bookName) {this.bookName = bookName;}/** * 获取图书作者 * @return 图书作者 */public String getAuthor() {return author;}/** * 设置图书作者 * @param author 图书作者 */public void setAuthor(String author) {this.author = author;}/** * 显示图书的信息 * @param bookName 图书名称 * @param author 图书作者 */public void showBook(String bookName,String author){//显示图书的信息 （不会生成在javadoc文档中）System.out.println("bookName:"+bookName+",author:"+author);}}

        使用eclipse生成javadoc的步骤：

        1.右键项目或要生成文档的类——>选择export——>选择Java下的Javadoc

         

      2.选择finish，会在项目下生成一个文件夹

     3.打开index.html效果如图

       

      这样javadoc文档就生成了，建议开发项目时一定要编写文档注释，虽然很简单，很费时，但写文档时就省事了。