当前位置:天才代写 > tutorial > JAVA 教程 > java的注释名目

java的注释名目

2017-11-13 08:00 星期一 所属: JAVA 教程 浏览:473

所有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文件的结果如何。

 

    关键字:

[contact-form-7 id="17097" title="form2"]天才代写-代写联系方式