黑马程序员_如何制作帮助文档？

最新推荐文章于 2014-08-20 07:28:38 发布

wxyrk

最新推荐文章于 2014-08-20 07:28:38 发布

阅读量437

点赞数

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/wxyrk/article/details/38016945

本文介绍了一个用于操作数组的工具类，包括获取最大值的方法，并展示了如何使用Javadoc生成对应的API文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

---------------------- <a href="http://www.itheima.com"target="blank">ASP.Net+Unity开发</a>、<a href="http://www.itheima.com"target="blank">.Net培训</a>、期待与您交流！ ----------------------

注释本行//
注释内容/*     */
文档说明书/**     */
文档说明书举例：
/** 这是一个可以对数组进行操作的工具类，该类中提供了获取最值、排序、等方法
* @author renkuo
* @version v1.1
* @since
*/
在相应的函数上加上相应的对函数属性，功能进行描述的语句，eg：

/**获取一个整形数组的最大值。
* @param arr 接受一个int型数组
* @return     会返回一个数组的最大值
*/
public static int getMax(int[] arr)
{
int max=0;
for(int x=1;x<arr.length;x++)
{
  if(arr[x]>arr[max])
   max=x;
}
return arr[max];
}
能够提取为说明文档的类必须是共有的。
怎么提取说明文档（帮助文档，API）？
Javadoc -d myhelp -author -version *****.java

---------------------- <a href="http://www.itheima.com"target="blank">ASP.Net+Unity开发</a>、<a href="http://www.itheima.com"target="blank">.Net培训</a>、期待与您交流！ ----------------------