如何生成java的"说明书"

本文详细介绍了如何使用Java文档注释为代码撰写详细的使用说明书,并通过实例演示了如何生成Javadoc,帮助用户更好地理解和使用Java类及方法。

现在无论买什么都会有说明书,买手机,有说明书,买冰箱,微波炉等等都会有说明书,那我们java自然也不另外,下面就教大家如何生成java的说明书。

首先写一份说明书要使用java的独有注释-文档注释
/**再按下回车,就是文档注释,而这个文档注释就是你为用户写的一份使用说明书
里面@author就是作者的意思,后面就是作者的名字(名字是可以自己随意更改的)
在这里插入图片描述
除了作者以外呢,还可以写版本@version 1.0 版本号是你随便写的
在这里插入图片描述
首先要在类里面写个方法,这个类里面的方法是提供给用户用的
假如我们写个求和的方法
在这里插入图片描述
接下来就要在文档注释的里边写类的功能是什么,这时候技术就不重要了,重要的是你的文笔了,注意,里边写的文字一定要在作者的上面

现在类的写好了,接下来就写方法了
在方法的上面打个文档注释,会出现它自带的注释,那里面的a,b和return都是方法里的参数
在这里插入图片描述
接下来你需要跟用户说明这方法是干嘛用的
在这里插入图片描述
写好说明之后呢,就开始生成java“说明书”了
点右击java文件,再单击我红色框住的Export
在这里插入图片描述
点进来就是这样,再点击java,选中javadoc,点击Next
在这里插入图片描述
能javadoc command:下面的路径是需要找到javadoc的可执行文件,每个人的路径都不一样,所以需要找到这个文件
在这里插入图片描述
最后点击Finsh,完成
去D盘看看
在这里插入图片描述
点进去doc
在这里插入图片描述
会发现有很多的文件,其他的不用管,直接双击index.html,也就是倒数第五个
在这里插入图片描述
点进来就是浏览器打开的网页
当你发现,文档注释里面的内容它都会提取出来,以网页的形式展示出来
对于用户的话是非常好,客户不需要研究生命,一看就会了,前提是你先得把自己的文笔功底练好,这样用户一看就会了。
那我们的说明书就已经做好了
//喜欢小编的话就给个关注呗!

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值