15.黑马程序员-帮助文档的制作

------- android培训、java培训、期待与您交流！ ----------

• 将一个静态ToolClass文件发过其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类。但是，很遗憾，该类中到底定义了多少个方法，对方却不清楚，因为该类并没有使用说明书。
• 开始制作程序的说明书。Java的说明书通过文档注释来完成。
  • /**
  • 这是一个一个可以对数组进行操作的工具类，该类中提供了，获得最值，排序等功能。
  • @author 张三
  • @version V1.1
  • */

    ---

    
    
  • /**
  • 获取一个整形数组中的最小值。
  • @param arr接受一个Int类型的数组。
  • @param a接受一个Int类型的变量。
  • @return 会返回一个该数组中的最小值。
  • */
• 写完以后，可以使用Javadoc生成文档。
  • 注意：这个类必须是public的
  • javac -d c:\myhelp -author -version ArrayTool.java.
  • 给类中的函数、构造函数前加上public才会生成在帮助文档中。
  • 一个类中默认（系统自动生成的）有个空参数构造函数，这个默认构造函数的权限和所属类一致。需要明确写出并且private防止被创建新对象。