博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Java生成javadoc
阅读量:6440 次
发布时间:2019-06-23

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

hot3.png

一、Javadoc介绍

Javadoc其实平常我们都会见到,JAVASE的API文档就是一个javadoc,很明显,Javadoc的目的是为了能够让外部客户理解我们的代码并使用我们对外的接口。

记住:编写Javadoc的时候只需要对外的接口即可,不需要内部的接口也编写Javadoc注释;

二、Javadoc注释

一般我们的注释形式是:

(1) //

(2) /*     */

而Javadoc注释的形式是:

/** 

  1.  *  

  2.  *   

  3.  */  

注意:必须以/**开头;

三、Eclipse生成Javadoc文档

1.编写Javadoc注释

在Eclipse中,如果在某个方法前面输入/**后回车,则会自动生成Javadoc注释的格式,比如:

[public void setAge(int age) {  

  1.     this.age = age;  

  2. }  

在以上代码的上一行输入/** 后回车,则会生成如下形式的注释:

/** 

  1.  *  

  2.  *  age  

  3.  */  

  4. public void setAge(int age) {  

  5.     this.age = age;  

  6. }  

2.生成Javadoc注释

如果想生成某个文件或工程的Javadoc文档,则右击后点击Export,然后选择javadoc,即可生成Javadoc;

(可能会出现编码问题,比如一个浏览器不会出现乱码,而一个浏览器会出现乱码,比如我生成的中文文档,safari是乱码,IE不是乱码);

四、示例

代码如下:

 * 创建Person对象的另一种方式 

  1.  *  name 姓名 

  2.  *  age 年龄 

  3.  *  Person对象 

  4.  */  

  5. public static Person getInstance(String name,int age){  

  6.     return new Person(name,age);  

  7. }  

则生成的形式如下:

转载于:https://my.oschina.net/u/1582930/blog/491630

你可能感兴趣的文章
SpaceX又拿下一笔大单,是来自美国空军的近亿元合同
查看>>
云栖大讲堂Java基础入门(二)—— 阿里专家与你分享:你必须注意的Java编程细节...
查看>>
2017年勒索软件、物联网攻击将继续肆虐
查看>>
区块链能解决你的文档和数字签名难题吗?
查看>>
.net Int16 、(int Int32)、 Int64 的区别
查看>>
用友网络董事长王文京为何出现在乌镇大会中?
查看>>
大学团队打造手语翻译机器人,完整安装下来需要149个小时
查看>>
Wireshark抓包分析/TCP/Http/Https及代理IP的识别
查看>>
不同包下,相同数据结构的两个类进行转换
查看>>
软件安装(linux)
查看>>
TeamPlain for VSTS - Web Access for Team System-TFS 跨平台的客户端
查看>>
面对前车之鉴的AR,现在的VR要做些什么?
查看>>
vscode 换行符\n 变成\r\n
查看>>
一个绘制虚线的非常规函数(常规方法,打印机上绘制不出虚线)
查看>>
获得本机的IP,掩码和网关
查看>>
大数据之 ZooKeeper原理及其在Hadoop和HBase中的应用
查看>>
Delphi中将XML文件数据装入DataSet
查看>>
你刚才在淘宝上买了一件东西
查看>>
C#正则表达式整理备忘
查看>>
发布一个 Linux 下的 C++ 多线程库
查看>>