[开发工具]使用javaDoc生成帮助文档

使用javaDoc生成帮助文档

1. 使用命令方式

   代码如下：

   public class Hello {
         String name;
       /**
        *
        * @param name
        * @return
        * @throws Exception
        */
       public String test(String name) throws Exception{
           return name;
       }
   }
   
   //System.out.println(f+a);
   
   
   

   • 在代码位置打开cmd窗口

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-bbL3bp5e-1632917524024)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929195856658.png)]

   • 输入javadoc -encoding UTF-8 -charset UTF-8 Hello.java并回车

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0Pz1eLbM-1632917524027)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200045625.png)]

   • 生成效果如下：

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9klJAF4f-1632917524028)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200210672.png)]

   • 打开index.html查看效果

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-vy0QKgj1-1632917524030)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200256068.png)]

2. 使用idea生成

   • 代码如上1

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wK9xoM24-1632917524031)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200430963.png)]

   • 在电脑上任意位置新建文件夹用来保存生成的文档，我随意建在桌面

   • 点击idea–》Tools–》Generate javaDoc…

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YM02nVKa-1632917524032)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200624254.png)]

   • 选在生成文件夹位置，输入编码格式和字符集设置UTF-8，点击ok，搞定，可以点击index.html查看效果

     [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FMZrTNzS-1632917524033)(C:\Users\a\AppData\Roaming\Typora\typora-user-images\image-20210929200756399.png)]

     [外链图片转存中…(img-FMZrTNzS-1632917524033)]