java的要领文档标志

除嵌入HTML和@see引用之外，要领还答允利用针对参数、返回值以及违例的文档标志。

1. @param
名目如下：
@param 参数名 说明
个中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦碰着一个新文档标志，就认为前一个说明竣事。可利用任意数量的说明，每个参数一个。

2. @return
名目如下：
@return 说明
个中，“说明”是指返回值的寄义。它可延续到后头的行内。

3. @exception
有关“违例”（Exception）的具体环境，我们会在第9章报告。简言之，它们是一些非凡的工具，若某个要领失败，就可将它们“扔出”工具。挪用一个要领时，尽量只有一个违例工具呈现，但一些非凡的要领也许能发生任意数量的、差异范例的违例。所有这些违例都需要说明。所以，违例标志的名目如下：
@exception 完整类名 说明
个中，“完整类名”明晰指定了一个违例类的名字，它是在其他某个处所界说好的。而“说明”（同样可以延续到下面的行）汇报我们为什么这种非凡范例的违例会在要领挪用中呈现。

4. @deprecated
这是Java 1.1的新特性。该标志用于指出一些旧成果已由改造过的新成果代替。该标志的浸染是发起用户不必再利用一种特定的成果，因为将来改版时大概摒弃这一成果。若将一个要领标志为@deprecated，则利用该要领时会收到编译器的告诫。