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

---------------------- <a href="http://www.itheima.com"target="blank">ASP.Net+Unity开发</a&gt;、<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&gt;、<a href="http://www.itheima.com"target="blank">.Net培训</a>、期待与您交流! ----------------------

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值