对于java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序.对于程序的文档化,最大的问题莫过于对文档的维护.若文档与代码分离,那么每次改变代码后都要改变文档,这无疑会变成相当麻烦的一件事情.解决的方法看起来似乎很简单:将代码同文档“链接”起来.为达到这个目的,最简单的方法是将所有内容都置于同一个文件.然而,为使一切都整齐划一,还必须使用一种特殊的注释语法,以便标记出特殊的文档;另外还需要一个工具,用于提取这些注释,并按有价值的形式将其展现出来.这些都是java必须做到的.
用于提取注释的工具叫作javadoc.它采用了部分来自java编译器的技术,查找我们置入程序的特殊注释标记.它不仅提取由这些标记指示的信息,也将毗邻注释的类名或方法名提取出来.这样一来,我们就可用最轻的工作量,生成十分专业的程序文档. 【程序编程相关:和记黄埔与微软合作 用户3G手机将与MS】
1 javadoc 【推荐阅读:德国电信牵手微软 将于今年夏季推出IPT】
【扩展信息:球无线局域网设备收入增长10%】javadoc输出的是一个html文件,可用自己的web浏览器查看.该工具允许我们创建与管理单个源文件,并生动生成有用的文档.由于有了jvadoc,所以我们能够用标准的方法创建文档.而且由于它非常方便,所以我们能轻松获得所有java库的文档.
2 具体语法所有javadoc命令都只能出现于“/**”注释中.但与平常一样,注释结束于一个“*/”.主要通过两种方式来使用javadoc:嵌入的html,或使用“文档标记”.其中,“文档标记”(doc tags)是一些以“@”开头的命令,置于注释行的起始处(但前导的“*”会被忽略).
有三种类型的注释文档,它们对应于位于注释后面的元素:类.变量或者方法.也就是说,一个类注释正好位于一个类定义之前;变量注释正好位于变量定义之前;而一个方法定义正好位于一个方法定义的前面.如下面这个简单的例子所示:
/** 一个类注释 */ public class doctest { /** 一个变量注释 */ public int i; /** 一个方法注释 */ ... 下一页