注释文档[Java编程]

关于Java语言,最关心的一项计划就是它并没有打算让人们为了写程序而写程序——人们也需求考虑程序的文档化问题.关于程序的文档化,最大的问题莫过于对文档的保护.若文档与代码别离,那么每次改变代码后都要改变文档,这无疑会变成相当麻烦的一件事情.

办理的办法看起来仿佛很简单:将代码同文档“链接”起来.为到达这个目的,最简单的办法是将全部内容都置于同一个文件.但是,为使一切都整齐划一,还必须利用一种特别的注释语法,以便标志出特别的文档;别的还需求一个工具,用于提取这些注释,并按有代价的情势将其展示出来.这些都是Java必须做到的.

用于提取注释的工具叫作javadoc.它采取了部份来自Java编译器的技术,查找我们置入程序的特别注释标志.它不但提取由这些标志指导的信息,也将毗邻注释的类名或办法名提取出来.这样一来,我们便可用最轻的工作量,生成非常专业的程序文档.

javadoc输出的是一个HTML文件,可用自己的Web浏览器查看.该工具答应我们成立和管理单个源文件,并活泼生成有效的文档.由于有了jvadoc,所以我们可以用尺度的办法成立文档.并且由于它非常便利,所以我们能轻松得到全部Java库的文档.