java的注释格局[Java编程]

全部javadoc号令都只能呈现于“/**”注释中.但和普通一样,注释完毕于一个“*/”.主要通过两种方法来利用javadoc:嵌入的HTML,或利用“文档标志”.此中,“文档标志”（Doc tags）是一些以“@”开首的号令,置于注释行的起始处（但前导的“*”会被忽视）.
有三种范例的注释文档,它们对应于位于注释背面的元素:类、变量大概办法.也就是说,一个类注释恰好位于一个类定义之前;变量注释恰好位于变量定义之前;而一个办法定义恰好位于一个办法定义的前面.以下面这个简单的例子所示:

/** 一个类注释 */
public class docTest {
/** 一个变量注释 */
public int i;
/** 一个办法注释 */
public void f() {}
}

注意javadoc只能为public（大众）和protected（受保护）成员处理注释文档.“private”（私有）和“友好”（详见5章）成员的注释会被忽视,我们看不到任何输出（也可以用-private标志包含private成员）.这样做是有原理的,因为只有public和protected成员才可在文件之外利用,这是客户程序员的但愿.但是,全部类注释城市包含到输出后果里.
上述代码的输出是一个HTML文件,它与其他Java文档具有相同的尺度格局.因此,用户会非常熟习这种格局,可在您计划的类中便利地“环游”.计划程序时,请务必考虑输入上述代码,用javadoc处理一下,傍观终究HTML文件的效果若何.