概述：

开发人员开发完代码分为源代码文件和字节码文件，将来给客户的文件是字节码文件，客户看不懂文件，不会使用该文件。为了要客户更好的使用书写的代码文件需要开发者提供一个文件的使用帮助文档

如何生成帮助文档？

不需要自己逐字逐句的书写，只需要使用jdk提供的一个程序javadoc.exe可以自动生成帮助文档。

步骤：

1、完成源文件的注释的书写

文档注释：【/** 注释内容 */】

注释内容需要结合相关注解来书写

帮助文档的常用注解：

@author：作者

@version：版本号

@since：从…开始 -------一般使用在类的注释中

@param：参数

@return：返回值 -------- 一般用于方法的注释中

2、生成帮助文档：javadoc.exe需要使用dos命令来调用

在文件所在的目录下的命令行中输入都是命令。

命令：javadoc -d 文件夹名称 -author -version 源文件名.java

eclipse生成帮助文档的步骤：

1、点击project中的generate javadoc…

2、在弹出的菜单中填写两个路径完成即可

帮助文档的制作（控制台、eclipse两种方式）相关推荐

还在为打印PDF文件发愁？文档开发工具Spire.PDF 6种方式帮你搞定！
Spire.PDF(点击下载)是一个专业的PDF组件,能够独立地创建.编写.编辑.操作和阅读PDF文件,支持 .NET.Java.WPF和Silverlight.Spire.PDF的PDF API拥有 ...
多可文档管理系统下载文件的几种方式
前面我们已经介绍过了上传文件到多可文档管理的方式,有上传就得有下载,所以这里要说的是如何从多可文档管理系统中下载文件. 1.单个文件下载单个文件的下载很简单: 先选择文件夹,再选中要下载的文件,点击 ...
badusb详细制作教程（两种方式实现远控）
badusb是一种几乎可以突破任何杀毒软件和防火墙的设备,堪称渗透测试利器文章目录前言一.什么是badusb? 二,badusb的优点三,badusb是如何攻击的? badusb原理 HID攻 ...
spark代码连接hive_Spark SQL入门到实战之（7）spark连接hive（spark-shell和eclipse两种方式）...
1.在服务器(虚拟机)spark-shell连接hive 1.1 将hive-site.xml拷贝到spark/conf里 cp /opt/apache-hive-2.3.2-bin/conf/hiv ...
怎么让上下两排对齐_Word文档如何让让上下两排对齐 - 卡饭网
电脑word文档软件中一屏两页的效果如何设置电脑word文档软件中一屏两页的效果如何设置有的小伙伴在电脑上使用Word文档软件时,想要设置一屏两页的效果,但是却不知道如何进行设置,那么小编就来为大 ...
计算机制作贺卡教案,初中信息技术《美化Word文档贺卡制作》教案
初中信息技术<美化Word文档贺卡制作>教案一.教学目标根据学生已有认知结构.学习现状及教学大纲的要求,制定如下教学目标: (一)认知目标掌握在Word文档中图片.剪贴画.艺术字和自 ...
怎么用超级文档免费制作调查问卷
制作一个问卷简单,但是制作一个比较好的调查问卷,就需要稍微花一些精力,问卷调查一般包括前导语.问题.结束语等几部分,再加上一个好的工具.问卷需要做到几点,首先尽量把题目设置得更"接地气&qu ...
设置Word文档密码的两种方式
重要的word文档,不想随便被别人打开来看怎么办?那就给它设置一个打开密码吧. Word的设置密码有两种方式: 第一种,打开Word文档后,依次点击上面工具栏的[文件]-[信息],再点击右侧[保护文档 ...
有数Bizhelp帮助文档在线制作软件官方
名称:有数Bizhelp帮助文档在线制作软件官方软件大小:6 MB 软件语言:简体中文软件官网:http://www.xiazai.com/ 软件授权:共享版应用平台:Win8/Win7/Win ...

帮助文档的制作（控制台、eclipse两种方式）

概述：

如何生成帮助文档？

步骤：

eclipse生成帮助文档的步骤：

帮助文档的制作（控制台、eclipse两种方式）相关推荐

最新文章

热门文章