JavaDoc与注释

JavaDoc与注释 JavaDoc与注释

javadoc命令是用来生成自己API文档的，（API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。）

javadoc可以将文档的注释信息生成一个帮助文档，类似于java的API。

参数信息

@author 作者名@version 版本号@since 指明需要最早使用的jdk版本@param 参数名@return 返回值情况@ throws 异常抛出情况

如：/**加回车，位置位于package下方，即可对该java文件进行注释。

对某个类进行注释，即在图示位置加/**回车，可自动生成类注释

通过命令行形成javadoc文档

找到所要生成文档的存储

在java文件的存储位置进行如下 *** 作

在前方输入cmd 加空格 ，输入如下字符串

即可在原有文件处找到帮助文件网站

点击进入即可查看

如何用IDEA实现生成javadoc文档？

首先创建存放javadoc的文档

点击所要生成帮助文档的文件，点击tools，

3.便可看到生成doc文档选项

		  4. 点击进入,按照顺序依次选择自己的选项，③代表的意思语言用zh_CN 代编中文，④是要这样输入，为啥这样输，目前我也不清楚。![请添加图片描述](https://img-blog.csdnimg.cn/b6e46f4b911a4ff1b1208fcfa2c7aa6f.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA6aaZ5qmZ5rC0,size_20,color_FFFFFF,t_70,g_se,x_16)
	
		  5. 点击ok，就可以在事先创建的文件中找到自己所要看的javadoc文档。