给自己的java程序生成API帮助文档
一.问题发现:
课本上提到“要学会给自己编写的程序生成API帮助文档”,但又没有说明具体的操作步骤。
二.分析:
API帮助文档有什么用?这么理解吧:如果想告诉别人你的类如何使用,里面有什么方法,要什么参数的话,除了现场解释,最好的方法是什么呢?
对了,就是写一份说明!一般开头可以有这么几项:
/**
* 项目说明
* @author 作者
* @version 版本
* @param 参数
* @return 返回值含义
* @throws 抛出异常的描述
* @deprecated 废弃,即不建议使用
*/
网上说用eclipse可以很方便地形成API帮助文档。于是拿了个以前编写的程序:
/**
* 循环测试
* @author java学习者
* @version 版本1.0
* @param 无
* @return 无
* @throws 无
* @deprecated 无
*/
package j2_14_38;
public class DoWhile
{
public static void main(String[] args)
{
int i=1;
do
{
System.out.println(“这是第 “+i+“次循环”);
//i=6即跳出循环
i++;
}while(i<6);
}
- 1
}
然后按以下步骤操作:
右击项目->导出(Export)->Java->javadoc->Next->Next->Next->Finish->Yes To All->Finish。
最后发现,在项目中,多了个doc文件夹!
最新文章
- Silverlight 缓存控制策略
- mssql中sp_executesql的用法
- Google首席软件工程师Joshua Bloch谈如何设计一款优秀的API【附PPT】
- MySQL的字符集
- WEB版一次选择多个文件进行批量上传(Plupload)的解决方案
- free(): invalid next size (fast/normal)问题
- [POJ2182]Lost Cows(树状数组,二分)
- 上传本地文件到HDFS
- 231. Power of Two
- Linux操作:
- D - Flip tile
- VMware vSphere 服务器虚拟化之十六 桌面虚拟化之VMware Horizon View
- MEAN全栈开发实践
- servlet规范核心类图
- 面试经验合集-Java后端<;一>;
- 深入理解Java虚拟机读书笔记1----Java内存区域与HotSpot虚拟机对象
- java并发编程知识点备忘
- 第七篇 python基础之函数,递归,内置函数
- [转]Introduction to Learning to Trade with Reinforcement Learning
- <;context:component-scan>;子标签:<;context:include-filter>;和<;context:exclude-filter>;使用时要注意的地方
热门文章
- teamviewer连接不上的原因及解决方法有哪些
- Vue使用Promise自定义confirm确认框组件
- xpath使用方法详解id 、starts-with、contains、text()和last() 的用法
- Mongodb总结1-启动和Shell脚本
- [转]C#连接操作mysql实例
- java三大特性:封装、继承、多态
- git各种命令 &; git merge和git rebase的区别
- windows 控制台下 无法获取完整的回车键值
- 4、基于JZ2440之编写测试代码处理(处理图片识别人脸)
- keil出现蓝色小箭头