Java文档的语法
在网站建设编码中所有javadoc命令都由/**注释符号开始,结束的标记同普通注释符号相同,也是*/。Javadoc有两种主要的用法:嵌入式的HTML和用文档标记(doc tags)。独立的文档标记是一些由@打头的命令,他们会被放在注释行的开头。(但是打头的那个*则被忽略了。)内嵌式文档标记则可以出现在任何地方,它也是由@开始的,但是要用花括号括起来。
注释文档根据它所注释的内容,分成三类:类、变量和方法。也就是说,类的注释一定要出现在类定义的前面;变量注释要出现在变量定义的前面;而方法注释则要出现在方法定义的前面。注释和定义之间不能有任何东西。
注意,javadoc只会处理public和protected的成员注释文档。它不会去管private和package访问权限的成员的注释。不过你也可以使用-private标记,将private成员也包括进去。这种做法是有道理的,因为从客户程序员的角度来看,他们只能访问到这个文件的public和protected成员。不过输出会包括所有class的注释。这些代码会生成HTML文件,它会同其它Java文档一样,有着相同的标准格式,因此用户查找类的时候就会觉得很舒服。