Java的注释 和Javadoc在eclipse生成的方法

作者: Arvin Chen 分类: Java的思想 来源: Break易站(www.breakyizhan.com)

1.  Java的注释


Java里有两种注释风格。下面这个写法是非常常见的

/*This is a comment
*that continues
*across lines
*/

还可以写成:

/*This is a comment that
continues across lines*/

第二种写法如下:

//This is one-line comment

2. Java的嵌入式文档


通常,我们把注释和代码都放到了同一个文件example.java里面,这是为了更好地维护Java文件的注释,因为如果说明文档和源代码分开的话,每次修改源代码之后,还要费力气去维护说明文档API。如果都写在一起,修改的同时,就可以一起维护了。

注释和源代码一起看有时候会比较繁琐,所以,JDK提供了给我们一个提取注释的工具javadoc。这个是能够在Java文件里面提取对应的注释,并且生成HTML文档,以供我们查阅的,非常方便。

那么,我们用eclipse怎么样提取javadoc呢,其实,就在eclipse的project里面就能够自动提取javadoc了。project → Generate javadoc

而javadoc的一些标签,可以使我们在注释文档和生成文档API的时候显得更加的专业,那么,具体的标签有什么呢?请参照下面的表格,查看常用的javadoc:

Java的注释 和Javadoc在eclipse生成的方法

本文内容来自:Java的注释和Javadoc在eclipse生成的方法 – Break易站


---Author: Arvin Chen ---Web Address: www.breakyizhan.com (Break易站)

  •   本文标题:Java的注释 和Javadoc在eclipse生成的方法 - Break易站
    转载请保留页面地址:https://www.breakyizhan.com/javamind/578.html

    发表笔记

    电子邮件地址不会被公开。 必填项已用*标注

    更多阅读