Java笔记(制作说明书)

Posted 言人冰

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java笔记(制作说明书)相关的知识,希望对你有一定的参考价值。

?制作说明书

?why

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

?how

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

如何使用IDEA生成Java Doc文档

生成javadoc文档注释之后,打开文件夹则可以看到以下效果

以上是关于Java笔记(制作说明书)的主要内容,如果未能解决你的问题,请参考以下文章

Java笔记(制作说明书)

[原创]java WEB学习笔记61:Struts2学习之路--通用标签 property,uri,param,set,push,if-else,itertor,sort,date,a标签等(代码片段

如何使用导航组件处理片段内的向上按钮

有道云笔记怎么排版 java代码

python 用于在终端中运行的sublime text 3的简单代码片段制作工具

学习笔记:python3,代码片段(2017)