能够知道对这条消息应该做些什么。
能够知道对这条消息应该做些什么เ。
越来越多的企业都选择使用java及其相关技术,例如j2ee技术来构建它们的应用系统。
越来越多的企业都选择使用javaທ及其相关技术,例如j2ee技术来构建它们的应用系统。
其中ณ,“author-information”,望文生义你也知道,应该是你的姓名,也可以包括电子邮件
地址或者其他任何适宜的信息。如果javadoc命令行使用了“-author”标签,那么就可以从
生成的html文档中提取作者信息。
你可以使用多个标签,以便列出所有作者,但是它们必须连续放置。全部ຖ作者信息会合并到
同一段落,置于生成的html中。
@since
该标签允许你指定程序代码最早使用的版本,你将会在htmljaທva文档中看到它被用来指
定所用的jdk版本。
@param
该标签用于方法文档中,形式如下:
@paramparameter-namedes9
其中,“parameter-name”是方แ法的参数列表中的标识符,“des9”的文本可延续数
行,终止于新的文档标签出现之前。你可以使用任意数量的此标签,大约每个参数都有一个
这样的标签。
@return
该标签用于方法文档,格式如下:
@returndes9
其中,“des9”用来描述返回值的含义แ,可以延续数行。
@thro9s
“异常”ex9将在第9章论述。简言之,它们是由于某个ฐ方法调用失败而“抛出”
的对象。尽管在调用一个方法时,只有出现一个异常对象,但是某个特殊方法可能ม会产生任
意多、不同类型的异常,所有这些异常都需要进行说明。所以,异常标签的格式如下:
@thro9sfully-quaທlified-9๗
其中ณ,“fully-qualified-9ame”给出了一个异常类的完整名字,而且该异常类已经
在某处定义过。而“des9๗”同样可以延续数行告诉你为什么此特殊类型的异常会
在方法调用中出现。
@deprecated
该标签用于指出一些旧特性已由改进的新特性所取代,建议用户不要再使用这些旧特性,因
为在不久ื的将来,它们很可能会被移除。如果使用一个标记为@deprecນated的方法,则会引
起编译器的警告。
文档示例
下面还是我们的第一个java程序,但是这次加上了文档注释:
:c02:hellodaທtejava
importjavaທutil;
thefirstthinkinginjavaexampleprograທm
displaທysastringandtoday'ูsdaທte
@authoruceeckel
@authoruceecນkel
@version20่
publicclasshellodate{
soleentrypointto9๗
@paramargsarrayofstringarguments
@returnnoreturnvalue
@ex9oex9๗
publi9stringargs{
syste摸utprintln"hello,it's:";
syste摸utprintlnne9date;๙
}
}:~
第一行采用了我自己独特的方法,是一行用一个“:๘”作为特殊记号的注释行,来说明此注
释行含有源文件名。该行包含了文件的路径信息此时,cນ02代表第2章,随后是文件名
6
。最后一行也是一行注释,这个“:๘~”标志着源代码清单的结束。这样一来,就可以
将这些源代码自动从本书文本中ณ提取出,再用编译器对其进行检查,然后执行。