博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
2018/01/01Java基础学习——如何通过dos系统的javadoc命令生成API文档
阅读量:4708 次
发布时间:2019-06-10

本文共 2148 字,大约阅读时间需要 7 分钟。

通常在Java原程序中插入类似这样的注释,/** ... ... */这样的格式可以通过Javados命令生成doc帮助文档。代码案例如下:

1 import java.util.Arrays; 2   3 /** 4  * Description 5  * 
this's a test class 6 * Created by test on 2017/2/7. 7 * @author MisJersion 8 * @version 1.8 9 */10 public class HelloWorld{11 public static void fill(int[][] array) {12 /**13 * 执行赋值操作14 */15 for (int i = 0; i < array.length; i++) {16 for (int j = 0; j < array[i].length; j++) {17 array[i][j] = (int) (Math.random()*100);18 }19 }20 }21 public static void sort(int[][] array) {22 /**23 * 先把二维数组使用System.arraycopy进行数组复制到一个一维数组24 * 然后使用sort进行排序25 * 最后再复制回到二维数组。26 */27 int[] a = new int[array.length * array[0].length];28 int b = 0;29 int c = 0;30 for (int i = 0; i < array.length; i++) {31 System.arraycopy(array[i],0,a,b,array[i].length);32 b += array[i].length;33 }34 Arrays.sort(a);35 System.out.println(Arrays.toString(a));36 for (int i = 0; i < array.length; i++) {37 System.arraycopy(a,c,array[i],0,array[i].length);38 c += array[i].length;39 System.out.println(Arrays.toString(array[i]));40 }41 }42 public static void main(String[] args) {43 int[][] a = new int[5][8];44 fill(a);45 sort(a);46 }47 }

下面讲解如何生成doc帮助文档

方法一:

  1. 打开dos界面:win + R, 然后输入cmd
  2. 拿我自己的.java路径来举例,输入:E:+enter
  3. 输入:cd E:\project\j2se\src,然后enter
  4. javadoc 类名.java,然后enter
  5. 打开根目录E:\project\j2se\src,找到index.html索引网页,双击打开,就可以查看了
  6. 点击其中的类,可以看到相应类的信息,如你设置的版本、作者,还可以看到继承的类等信息,有助于快速了解源代码

  方法一的优点是快速,其实还有一种,但是建成的.HTML文件比较乱。所以推荐了下面的方法。

方法二:参考链接: 

  1. 第一步方法同『方法一』的前三步
  2. 创建api文件,进行文档生成:输入『javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author 类名.java
  3. 打开根目录E:\project\j2se\src:可以看到生成了一个文件夹javaapi,这样就不乱了。

   

  【note注意】上述的类名.java在这里是HelloWorld.java。

 

转载于:https://www.cnblogs.com/lijiehua/p/8166309.html

你可能感兴趣的文章
定义列属性:null,default,PK,auto_increment
查看>>
用户画像展示
查看>>
C#中StreamReader读取中文出现乱码
查看>>
使用BufferedReader的时候出现的问题
查看>>
批处理文件中的路径问题
查看>>
hibernate出现No row with the given identifier exists问题
查看>>
为什么wait()和notify()属于Object类
查看>>
配置NRPE的通讯
查看>>
匹配两个空格之间的字符。。。
查看>>
CSS 文字溢出 变成省略号 ...
查看>>
Spring事务
查看>>
java编程基础(三)流程控制语句
查看>>
让数据库跑的更快的7个MySQL优化建议
查看>>
jquery 取id模糊查询
查看>>
解决在vue中,自用mask模态框出来后,下层的元素依旧可以滑动的问题
查看>>
SSH加固
查看>>
python 二维字典
查看>>
实验吧之【天下武功唯快不破】
查看>>
2019-3-25多线程的同步与互斥(互斥锁、条件变量、读写锁、自旋锁、信号量)...
查看>>
win7-64 mysql的安装
查看>>