javadoc是为了方便在程序文档的生成,在程序的注释中采用规定的语法,可以方便的更改程序,同时更改注释,通过javadoc可以将注释导出为html文档,提高了文档的编写效率。
标记已以/**开始,以*/结束。中间涉及版本,作者,变量,参数,返回值,异常等
//: helloWorld.java
/**
* This is my first java using Thinking in java
* The Project is helloWorld,the main java file
* is helloWorld.java
* @author ddxx
* @version version1.0
*/
public class helloWorld {
/**
*Sole entry point for the program
* @param args array of string arguments
* @return no return
* @exception no throw for this function
* @
*/
public static void main(String []args)
{
System.out.println("hello world\n");
}
}
其中以@开头的都是要标记的关键词。在编辑的时候就可以从代码编辑器下面的javadoc里可以看到。
导出javadoc,在file->export->java->javadoc中即可,后面要填写一些配置命令,注意javadoc command中填写javadoc.exe所在的路径就可以了,比如说:
C:\Java\jdk1.7.0_10\bin\javadoc.exe。