给自己的java程序生成API帮助文档
来源:互联网 发布:vb.net 源代码 编辑:程序博客网 时间:2024/05/21 10:51
一.问题发现:
课本上提到“要学会给自己编写的程序生成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);
}
}
然后按以下步骤操作:
右击项目->导出(Export)->Java->javadoc->Next->Next->Next->Finish->Yes To All->Finish。
最后发现,在项目中,多了个doc文件夹!
- 给自己的java程序生成API帮助文档
- Java自己生成struts帮助文档方法
- 文档注释使用javadoc工具生成自己的api帮助文档
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 一个给 Java 程序员用的 Api 文档生成工具
- 一个给 Java 程序员用的 Api 文档生成工具
- 一个给 Java 程序员用的 Api 文档生成工具
- 一个给 Java 程序员用的 Api 文档生成工具
- java API 帮助文档
- Java生成自己项目API文档
- Java 生成帮助文档
- java中我们如何制作我们自己的API帮助文档
- 如何生成自己项目的API文档
- myeclipse生成HTML格式的API帮助文档实例
- JAVA项目文档注释规范&&生成自己项目的API文档
- java学习之旅26--api文档_package的概念_生成自己项目的api文档
- Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档
- Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档 .
- 什么叫线程安全
- CF 472A Design Tutorial: Learn from Math
- 苹果机器人产线很会 拆解iPhone已上手
- 数据结构学习笔记(八)--最短路径
- Jackson 框架,轻易转换JSON
- 给自己的java程序生成API帮助文档
- 网站整合
- 第四周
- iOS9 之后设置状态栏的颜色
- 自定义View模板(一)
- JVM8 元空间
- 【贪心】HDU 1257
- java内置核心语言对象
- Android 一张图理解getWidth和getMeasuredWidth