java的办法文档标志[Java编程]

除嵌入HTML和@see引用之外,办法还答应利用针对参数、返回值以及违例的文档标志.

1. @param
格局以下:
@param 参数名 阐明
此中,“参数名”是指参数列表内的标识符,而“阐明”代表一些可持续到后续行内的阐明文字.一旦碰到一个新文档标志,就认为前一个阐明完毕.可以利用肆意数目的阐明,每个参数一个.

2. @return
格局以下:
@return 阐明
此中,“阐明”是指返回值的含义.它可持续到背面的行内.

3. @exception
有关“违例”（Exception）的具体情形,我们会在第9章报告.简言之,它们是一些特别的对象,若某个办法失利,便可将它们“扔出”对象.调用一个办法时,固然只有一个违例对象呈现,但一些特别的办法大概能产生肆意数目的、差别范例的违例.全部这些违例都需求阐明.所以,违例标志的格局以下:
@exception 完好类名 阐明
此中,“完好类名”明确指定了一个违例类的名字,它是在其他某个地方定义好的.而“阐明”（一样可以持续到下面的行）奉告我们为什么这种特别范例的违例会在办法调用中呈现.

4. @deprecated
这是Java 1.1的新特点.该标志用于指出一些旧功效已由改良过的新功效代替.该标志的作用是倡议用户没必要再利用一种特定的功效,因为将来改版时大概摒弃这一功效.若将一个办法标志为@deprecated,则利用该办法时会收到编译器的告诫.