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

---------------------- ASP.Net+Unity开发.Net培训、期待与您交流! ----------------------

注释本行//
注释内容/*     */
文档说明书/**     */
文档说明书举例:
/** 这是一个可以对数组进行操作的工具类,该类中提供了获取最值、排序、等方法
 * @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  {
  if(arr[x]>arr[max])
   max=x;
 }
 return arr[max];
}
能够提取为说明文档的类必须是共有的。
怎么提取说明文档(帮助文档,API)?
Javadoc -d myhelp -author -version *****.java

---------------------- ASP.Net+Unity开发.Net培训、期待与您交流! ----------------------

你可能感兴趣的:(黑马程序员_如何制作帮助文档?)