java中我们如何制作我们自己的API帮助文档
1、首先我们要清楚源码注释规范,所需使用特殊的注释是/**填写功能内容*/。注释上可以添加我们所需的特殊内容。例如:@author author_name(作者)、@version(版本)、@param variable_name(参数)、@return description(悦耍强方法的返回值)。想了解更多javadoc 标记,建意在CSDN博客找。
2、编写一个我们需要的工具类,类中编写实现功能的属性和方法。我们对这个类的每一个属性和方法进行注释,在调用该类的时候,会提处三示该类方法的作用和参数以及返回值。
3、编写完后,可以按槐五“窗口+R”快速打开运行命令,再输入CMD,弹出命令窗口。然后在里面写"javadoc -d javaIO -author -version 源代码 "或"javac 原代码”,其中-d表示要保存的位置。
声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
阅读量:87
阅读量:42
阅读量:52
阅读量:38
阅读量:133