java关于javadoc的那些小技巧和你需要知道的地方(一)

﹏ヽ暗。殇╰゛Y 2022-06-16 03:54 288阅读 0赞

1.生成javadoc  
生成javadoc的方法很普遍,大家在晚上找找就有  
我这就转一下:[http://blog.csdn.net/u011596810/article/details/50825748][http_blog.csdn.net_u011596810_article_details_50825748]  
方法都是一样的,没有必要在我找,我就把博主的内容给大家转过来一起看看:  
![这里写图片描述][SouthEast]  
![这里写图片描述][SouthEast 1]  
最初的时候，我也很好奇它是怎么来的，就以为像平常的参考书一样，都是别人一字一笔制作出来的。但是，等我认识到javadoc这个东东的时候，我才发现，可以差不多是一键就能生成这种文档了。。。  
其实缘由可以由我们最初学习Java注释的时候看出，我们都知道，Java注释分为三种：行注释（//）、段落注释（/\* */）、文档注释（/\** \*/），为什么称为文档注释？其中，其重要功能之一，便是用于生成HTML说明文档。  
本文将讲解两部分：  
1、使用cmd命令窗口对一个java文件进行生成文档说明  
2、使用eclipse对于一个项目进行生成文档说明

1、使用cmd命令窗口对一个java文件进行生成文档说明  
（1）首先，我们应该在磁盘中创建一个java文件，例如：E:\\FirstJavaDoc.java  
里面的大致内容如下：

/** * 测试JavaDoc * @author 红叶岭谷 * */  
    public class FirstJavaDoc{   
        public static void main(String[] args){  
            addFunction("Hello JavaDoc!");  
        }  
    
        /** * 添加方法 * @param obj * 所需要输出的内容 */  
        public static void addFunction(Object obj) {  
            System.out.println(obj.toString());  
        }  
    }

（2）打开cmd命令行窗口，进入到java文件的当前路径，输入 javadoc 文件名.java  
![这里写图片描述][SouthEast 2]  
点击回车出现  
![这里写图片描述][SouthEast 3]  
就成功了  
如果出现javadoc不是内部命令,请检查你的java的jdk环境配置  
打开文件夹有:  
![这里写图片描述][SouthEast 4]  
打开index.html  
![这里写图片描述][SouthEast 5]  
前提是你的java文件必须是可读性的没有加密乱码之类的就可以刻  
这个是HTML的,如果你觉得这样还是不够好,你可以试着将它转成chm文件,既小又好用  
欢迎关注:  
java关于javadoc的那些小技巧和你需要知道的地方(二)

[http_blog.csdn.net_u011596810_article_details_50825748]: http://blog.csdn.net/u011596810/article/details/50825748
[SouthEast]: /images/20220616/23d44948d7674437b7a7b1c165b3575e.png
[SouthEast 1]: /images/20220616/f8bfcc4f61254c9fb886243f6bbbefa8.png
[SouthEast 2]: /images/20220616/63fd1002509c45f8bb0bfdff68a949f4.png
[SouthEast 3]: /images/20220616/02d4a273928e4c83a9a5fc8769c7dbe4.png
[SouthEast 4]: /images/20220616/59ce074e2ec84dff8e1f1c9efde7b166.png
[SouthEast 5]: /images/20220616/1056e2aa3a8a4edaaffba54c9f41f0e1.png