javadoc
Sun公司提供的技术
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
常用标记
此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们不展开叙述,感兴趣的读者可以查看帮助文档。
命令格式
JavaDoc 命令的语法格式如下:
javadoc [options] [packagenames] [sourcefiles] [@files]
其中包括以下几个元素:
- javadoc:表示要执行的命令。
- [options]:可选参数,用于指定Javadoc命令的选项和标记。
- [packagenames]:可选参数,用于指定要生成文档的包名称。
- [sourcefiles]:可选参数,用于指定要生成文档的源代码文件。
- [@files]:可选参数,用于指定包含其他选项和标记的文件。
参考资料
最新修订时间:2024-03-17 16:40
目录
概述
常用标记
参考资料