Java笔记（制作说明书）

最新推荐文章于 2024-11-01 14:48:20 发布
最新推荐文章于 2024-11-01 14:48:20 发布
阅读量149 收藏
点赞数
分类专栏： Java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/YRB20/article/details/120687817
版权
本文档介绍了在Java开发中，如何通过编写文档注释和使用Javadoc工具，为未知的class文件生成详细的说明文档。步骤包括创建工具类，添加文档注释，使用IDEA的快捷键生成多行及文档注释，最后通过DOS窗口或IDEA内置功能运行Javadoc命令生成最终的说明书。生成的文档有助于理解类的功能和参数使用。
摘要由CSDN通过智能技术生成

？制作说明书

?why

在以后的实际开发中，你实际收到的不是一个java文件，而是一个class文件。而你是不知道这个类中封装的方法的作用以及要传的参数等，故需要自己生成一个说明书！

?how

a.写一个工具类
b.对这个类加入文档注释，IDEA中快捷键：/** + enter (多行注释) /** + tab(文档注释)
c.用工具解析文档注释【javadoc工具】
d.在DOS窗口输入以下格式：
Javadoc -d目录 -author -version 类名.java
在IDEA中的操作如下：

如何使用IDEA生成Java Doc文档

生成javadoc文档注释之后，打开文件夹则可以看到以下效果
在这里插入图片描述

在这里插入图片描述

言人冰
关注
专栏目录
毕向东Java笔记（全部）
weixin_41700993的博客
05-09 2247
文章目录目录DOS命令进制转换数据类型定义变量的格式类型转换转义字符赋值运算符逻辑运算符位运算符 目录 DOS命令 在DOS里新建文件 copy con Demo.java class Demo{ public static void main(String[] args){ System.out.println("Hello Java"); } } Ctrl+Z 保存 type Demo...
java编程思想（读书笔记）：21.并发
10-23 1010
到目前为止，你学到的都是有关 顺序编程 的知识。即程序中的所有事物在任意时刻都只能执行一个步骤。 下面我们应该学一学并发编程吧。并发“具有可论证的确定性，但是实际上具有不可确定性”。实际上，你可能无法编写出能够针对你的并发程序生成故障条件的测试代码。Web系统是最常见的Java应用系统之一，而基本的Web库类，Servlet具有天生的多线程性–这很重要，因为Web服务器经常包含多个处理器，而并发是充
Java 说明书的制作
尘迦子的博客
10-11 156
Java说明书的制作 1.制作一个工具类 ArrayTool 获取最大值 数组的遍历 数组的反转 /** 这是一个数组工具类,里面封装了查找数组最大值,打印数组,数组反转的方法 @author fengjia @version v1.0 */ public class ArrayTool { ] //如果一个类中所有的方法都是静态的,需要再多...
JAVA说明书的制作
爱思考的小伙
11-27 312
JAVA说明书的制作 package docx; /* * 说明书的制作： * 1.编辑函数 * 2.注释内容 * 3.说明书生成：在源文件目录输入DOS命令(javadoc -d api -version -author ArrayTool.java) * 4.在本地目录生成文件夹api，进入文件(index.html)即可看见制作的说明书 * */ /** * 这是一个数组工具类...
笔记-Java面向对象编程-如何制作一个说明书呢
qq_28523741的博客
05-12 92
A：写一个工具类 B：对这个类加入文档注释 怎么加呢？ 加些什么东西呢？ C：用工具解析文档注释 javadoc工具 D：格式 javadoc -d 目录 -author -version ArrayTool.java 目录：就可以写一个文件夹的路径 制作帮助文档出错： 找不到可以文档化的公共或受保护的类：告诉我们类的权限不够 ...
java说明书怎么制作
Ting1king的博客
01-12 617
如何制作说明书呢？ 1.下面这个图是制作过程 2.下面用一个例子来演示，我自己写了一个类，并且已经写好了注释 /** * 这是针对数组进行操作的工具类 * @author 徐金鹏 * @version v.1 */ class ArrayTool{ private ArrayTool(){} /** * 这是遍历数组的方法，遍历后的元素：元素1，元素2，元素3... *@param ar...
JavaSE——day6如何制作一个简单的类说明书
malaganguo的博客
04-11 230
为什么要做说明书？    在我们面向对象编程思想中，我们是一个指挥着，所以我们需要做的只是对类的调用。如果制作一个类工具供我们的伙伴使用，那么我们至少应该告诉我们的伙伴这个类是干什么用的、怎么使用这个类中的方法、还有这个类的一些基本信息。这会大大提高我们面向对象变成的效率。        如何制作说明书？        我们首先要考虑的是，我们需要一些具有什么有关联的方法。比如说，我们需要制作一个...
制作CHM格式的Java学习笔记
nshkfhwr的博客
03-26 485
1.相关制作工具 * Markdown写作工具：Typro * 写作md学习笔记 * CHM制作工具：妙网电子书制作大师 * 导出书刊：选CHM格式
SSM整合---狂神说Java学习笔记
rzz65452064的博客
11-29 2822
SSM 整合 哔哩哔哩狂神说Java学习网址 文章只为分享学习经验和自己复习用，学习还是该去查看正规视频网站和官方文档才更有效 文章目录SSM 整合一、环境要求二、数据库环境三、基本环境搭建四、Mybatis层编写五、Spring层编写六、Spring MVC层编写七、Controller 和 视图层编写1、先简单编写，测试一下后端底层代码是否正确2、开始正是编写前端3、添加书籍4、修改、删除书籍八、项目结构图九、全部代码十、小结及展望十一、报错或Eclipse使用问题1、eclipse-maven-web
计算机读书笔记整理与分享
标签"源码软件 计算机读书笔记word版"中的"源码软件"可能指的是与软件开发相关的内容，这说明笔记中可能包含了大量的编程语言源码、软件架构设计、算法实现等技术性细节。而"计算机读书笔记word版"则再次强调了文件...
Java学习笔记-02
HOOHV的博客
02-05 272
Java学习笔记 - 01 简单的Java程序设计 基本程序设计 编写简单的程序 下面，我们用一个计算圆面积的简单问题，来学习基本的程序编写。 算法 算法是解决问题所需执行的动作以及这些动作的顺序，可以帮助程序员更好的理解问题，提高编程效率。在编写代码前，以一种算法的形式来勾勒你的程序，是一种很好的做法。此问题的算法自然语言描述如下： 1）读入半径 2）利用圆的面积公式计算面积 3）显示面...
Java文档说明书的制作
cangerwjd的博客
04-12 1001
以数组为例，制作属于自己的文档说明书！/** *  针对数组操作的工具类 *      如何制作一个文档说明书 *              1)创建一个数组,静态初始化 *              2)创建一个工具类,ArrayTool,提供一些静态功能 *                      遍历,最值,查找 *              3)ArrayTool,每类,方法加上文档注释...
java程序使用说明书的制作
深情小建
07-28 1338
/* 将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类。【set classpath=.;c:\myclass】 但是，很遗憾，该类中到底定义了多少个方法，对方却不清楚。因为该类并没有使用说明书。 开始制作程序的说明书。java的说明书通过文档注释来完成 javadoc -d myhelp -author -versio
制作Java说明书、使用帮助文档
子夜小雨落满围城
03-15 1233
#小知识点：把构造方法私有，外界就不能创建对象了。要调用一个类的方法，就只能直接用该类的类名调用。#制作一个说明书：    A：写一个工具类    B：对这个类加入文档注释    C：用工具解析文档注释        javadoc工具    D：格式                javadoc -d 目录 -author -version ArrayTool.java           目录...
[自用，更新自day5]瑞吉外卖代码及笔记
最新发布
lapiii的博客
11-01 419
当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。Mybatis Plus公共字段自动填充，也就是在插入或者更新的时候为指定字段赋予指定的值，使用它的好处就是可以统一对这些字段进行处理，避免了重复代码。因为在分页查询的Dish的records(菜品记录中)，只有这个菜品所属的categoryId，但是我们需要分页的时候展示的是菜品名字。
基于vue框架的的汇生活家居商城的设计与实现bdjlq（程序+源码+数据库+调试部署+开发环境）系统界面在最后面。
h2345678的博客
10-29 1271
项目功能：商品分类,商品信息,用户。
（1）Java 编程基础概览：数据类型、常量、变量、标识符与运算符
码界领航的Cherry Yang的博客
10-28 1048
8 位，占1个字节，有符号的，范围 -128（-2^7）至 127（2^7-1）。32 位，占4个字节，范围 -2,147,483,648（-2^31）至 2,147,483,647（2^31 - 1）。Java 提供了六种数字类型，其中四个为整数类型，两个为浮点类型，还有字符类型，以及布尔型。16 位，占2个字节，范围 -32768（-2^15）至 32767（2^15 - 1）64 位，占8个字节，范围 -2^63 至 2^63 - 1。16 位 Unicode 字符，占 2 个字节。
SpringSession源码分析
lkr_lkr的博客
11-01 111
默认对常规Session的理解和使用，如何使用Set-Cookie。
ssm智慧社区电子商务系统+vue
weixin_44832324的博客
10-28 1235
系统能否进行正常工作，功能模块能否实现，程序代码是否有错误，这些都需要通过系统测试来进行判断，测试是程序开发中必不可少的步骤，就算系统一步不差的被开发出来了，但进行测试时总能发现一个之前从没遇到过的问题[26]。在系统开发的整个过程当中都需要不断进行系统测试，根据经验发现，前期的一个小问题，将会酿成后期的一个大问题，所以越早发现，越早解决，才能保证后续的编码、测试和设计能够顺利进行。目前，系统测试所使用的方法主要是黑盒测试，系统测试的目的包括：根据客户的需求来设计用户界面；
JAVA读书笔记共享平台开发与部署教程
资源摘要信息: "计算机毕业设计JAVA读书笔记共享平台mybatis+源码+调试部署+系统+数据库+lw" 知识点一：计算机毕业设计 计算机毕业设计是指计算机科学与技术专业的学生在毕业前为了满足毕业要求而完成的具有一定...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值