摘要:jdk工具javadoc的作用是“生成Java文档”;javadoc是Java文档生成器,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。相关推荐:《Java视频教程》
jdk工具javadoc的作用是“生成Java文档”;javadoc是Java文档生成器,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
相关推荐:《Java视频教程》
jdk工具javadoc的作用是“生成Java文档”。
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
常用标记
标签说明JDK 1.1 doclet标准doclet标签类型@author 作者作者标识√√包、 类、接口@version 版本号版本号√√包、 类、接口@param 参数名 描述方法的入参名及描述信息,如入参有特别要求,可在此注释。√√构造函数、 方法@return 描述对函数返回值的注释√√方法@deprecated 过期文本标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。√√包、类、接口、值域、构造函数、 方法@throws异常类名构造函数或方法所会抛出的异常。此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们不展开叙述,感兴趣的读者可以查看帮助文档。
更多编程相关知识,请访问:编程入门!!
相关文章推荐
网站谷歌评分90+意味着什么?2022-09-06
怎样将不安全网站变成安全网站访问?2022-09-26
网站排名下降,可能跟算法更新没关系2022-09-20
网站如何设置高质量的网页标题?2022-09-14
做外贸网站选哪些语言?法语、德语最吃香2022-09-13