java⽂档注释的符号怎么打_javadoc⽂档注释.
对于Java语⾔，最抚恤的⼀项设计即便它并未曾计划让⼈们为了写过程⽽写过程——⼈们也必需琢磨过程的⽂档化问题。对于过程的⽂档化，最⼤的问题莫过度对⽂档的维护。若⽂档与代码离别，那么每次改换代码后都要改换⽂档，这⽆疑会变成相当繁琐的⼀件事情。处理的措施看起来好像很容易：将代码同⽂档“链接”起来。为到达这个⽬标，最容易的措施是将所有内容都置于统⼀个⽂件。然⽽，为使⼀切都整齐划⼀，还定然利⽤⼀种特异的注释语法，以便符号出特异的⽂档；另外还必需⼀个⼯具，⽤于提取这些注释，并按有价值的形式将其揭⽰出来。这些都是Java定然做到的。
⽤于提取注释的⼯具叫作javadoc。它批准了局部来⾃Java编译器的技巧，查我们置⼊过程的特异注释符号。它不但提取由这些符号指⽰的消息，也将毗邻注释的类名或措施名提取出来。这么⼀来，我们就可⽤最轻的⼯作量，⽣成极其专业的过程⽂档。
javadoc输出的是⼀个HTML⽂件，可⽤⾃⼰的Web博览器察看。该⼯具批准我们创⽴和管教个体源⽂件，并⽣动⽣成有⽤的⽂档。由于有了jvadoc，因⽽我们能够⽤规范的措施创⽴⽂档。⽽且由于它极其得体，因⽽我们能迅捷获得所有Java库的⽂档。
2 翔实语法
所有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⽂件的收获如何。
3 嵌⼊HTML
javadoc将HTML号召递交给最后⾝成的HTML⽂档。这便使我们能够富余利⽤HTML的宏伟威风。当然，我们的最后动机是款式化代码，不是为了阿谀恭维。下⾯列出⼀个例⼦：
亦可象在其他Web⽂档⾥那样利⽤HTML，同等闲⽂本举⾏款式化，使其更具条理、更加美观：
当⼼在⽂档注释中，位于⼀⾏最开始的星号会被javadoc丢弃。同时丢弃的还有前导空格。javadoc会对所有内容举⾏款式化，使其与规范的⽂档表⾯相称。不要将
或
这么的题⽬当作嵌⼊HTML利⽤，因为javadoc会插⼊⾃⼰的题⽬，我们给出的题⽬会与之撞击。
所有种类的注释⽂档——类、变量和措施——都扶持嵌⼊HTML。
4 @see：引⽤其他类
所有三种种类的注释⽂档都可包括@see符号，它批准我们引⽤其他类⾥的⽂档。对于这个符号，javadoc会⽣成相应的HTML，将其直接链接到其他⽂档。款式如下：
@see 类名
@see 全⾯类名
@see 全⾯类名
每⼀款式都会在⽣成的⽂档⾥积极加⼊⼀个超链接的“See
Also”(参见)条⽬。当⼼javadoc不会察看我们指定的超链接，不会检讨它们是否管⽤。
5 类⽂档符号
追随嵌⼊HTML和@see引⽤，类⽂档还能够包括⽤于版本消息以及作者姓名的符号。类⽂档亦可⽤于“接⼝”⽬标(本书后⾯会翔实解释)。
1. @version
款式如下：
@version 版本消息
其中，“版本消息”代表任何符配合为版本解释的材料。若在javadoc号召⾏利⽤了“-version”符号，就会从⽣成的HTML⽂档⾥提取出版本消息。
2. @author
款式如下：
@author 作者消息
其中，“作者消息”包括您的姓名、电⼦函件地址可能其他任何轻便的材料。若在javadoc号召⾏利⽤了“-author”符号，就会专程从⽣成的HTML⽂档⾥提取出作者消息。
可为⼀系列作者利⽤多个这么的符号，但它们定然继续放置。全副作者消息会同时存⼊最后HTML代码的独⾃⼀个段落⾥。
6 变量⽂档符号
变量⽂档只能包括嵌⼊的HTML以及@see引⽤。
7 措施⽂档符号
除嵌⼊HTML和@see引⽤之外，措施还批准利⽤针对参数、归来值以及违例的⽂档符号。
1. @param
款式如下：
@param 参数名 解释
其中，“参数名”是指参数列表内的标识符，⽽“解释”代表⼀些可继续到后续⾏内的解释⽂字。⼀旦遭到⼀个新⽂档符号，就感受前⼀个解释告终。可利⽤任意数量的解释，每个参数⼀个。
2. @return
款式如下：
@return 解释
其中，“解释”是指归来值的含义。它可继续到后⾯的⾏内。java修改html文件
3. @exception
有关“违例”(Exception)的翔事实况，我们会在第9章解说。简⾔之，它们是⼀些特异的对象，若某个措施失利，就可将它们“扔出”对象。调⽤⼀个措施时，尽管只有⼀个违例对象揭⽰，但⼀些特异的措施可能能发⽣任意数量的、不同种类的违例。所有这些违例都必需解释。因⽽，违例符号的款式如下：
@exception 全⾯类名 解释
其中，“全⾯类名”确定指定了⼀个违例类的名字，它是在其他某个地⽅定义好的。⽽“解释”(同样能够继续到下⾯的⾏)告诉我们为什么这种特异种类的违例会在措施调⽤中揭⽰。
4. @deprecated
这是Java
1.1的新个性。该符号⽤于指出⼀些旧功能已由改进过的新功能顶替。该符号的作⽤是提倡⽤户⽆须再利⽤⼀种特定的功能，因为未来改版时可能屏弃这⼀功能。若将⼀个措施符号为@deprecated，则利⽤该措施时会收到编译器的警告。等闲给旁⼈的⼯作挑错要⽐⾃⼰的错轻率些。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。