代码文档document,其撰写的最大问题,大概就是对文档的维护。
如果文档与代码是分离的,那么每次修改代码时,都需要修改相应的文档,这相当乏味。
为解决这个问题,我们将代码同文档“链接”起来。
1、为达到这个目的,最简单的方法是将所有东西都放在同一个文件内。
2、另外,还必须使用一种特殊的注释语法来标记文档;
3、以及一个工具,用于提取那些注释,并将其转换为有用的形式。
javadoc
javadoc,便是用于提取注释的工具。在下载的jdk(Java developer's kit)里面。
它采用了Java编译器的某些技术,查找程序内的“特殊”注释标签。
它不仅解析由这些标签标记的信息,也将毗邻这些特殊注释的类名或方法名抽取出来。
javadoc输出一个HTML文件,可以通过浏览器查看。
javadoc能使我们只需创建和维护单一的源文件,并能自动生成有用的文档。有了javadoc,即有了创建文档的简明直观的标准。
拓展:
如果想对javadoc处理过的信息执行特殊的操作,比如产生不同格式的输出,则可以通过编写你自己的被称为doclets的javadoc处理器来实现。
下面,我们将对javadoc进行简单的介绍和概述,全面的描述可以同jdk document中的tooldocs找到
语法
所有javadoc命令,都只能在“/**”注释中出现,