在网站建设编码中所有javadoc命令都由/**注释符号开始,结束的标记同普通注释符号相同,也是*/。Javadoc有两种主要的用法:嵌入式的HTML和用文档标记(doc tags)。独立的文档标记是一些由@打头的命令,他们会被放在注释行的开头。(但是打头的那个*则被忽略了。)内嵌式文档标记则可以出现在任何地方,它也是由@开始的,但是要用花括号括起来。
注释文档根据它所注释的内容,分成三类:类、变量和方法。也就是说,类的注释一定要出现在类定义的前面;变量注释要出现在变量定义的前面;而方法注释则要出现在方法定义的前面。注释和定义之间不能有任何东西。
Java有一些很好的想法,其中一条就是,写代码并不是唯一重要的事情——制作文档至少和它同等重要。但是文档工作的难点在于维护。如果文档与程序是相互分离的,那么每次修改完程序之后,你还得跟着改文档,这就很麻烦了。解决方案似乎很简单,把代码同文档联系起来。最简单的方法是把它们放到同一个文件里。但是要完成这个步骤,你就得用一种特殊的语法来标注文档,然后用一个工具把注释提取出来,再形成能用的格式。
这个提取注释的工具就是javadoc,它会随JDK一道安装。它用了一些Java编译器的技术来查找你放在程序里面的特殊的注释标记。它不仅能提取这些标注的信息,而且还会把注释周围的类名和方法名都给提取出来。这样,你就能用最少的工作量来生成一份还过得去的文档了。