如何生成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,也就是倒数第五个
点进来就是浏览器打开的网页
当你发现,文档注释里面的内容它都会提取出来,以网页的形式展示出来
对于用户的话是非常好,客户不需要研究生命,一看就会了,前提是你先得把自己的文笔功底练好,这样用户一看就会了。
那我们的说明书就已经做好了
//喜欢小编的话就给个关注呗!