java javaDoc 生成说明文档

这一篇我们说javaDoc说明文档 其实还是规范 和 代码可读 易读 别人读的懂 。。真的很重要

建议搜java的jdk帮助文档 （但是最新的好像没有中文）

下面是一个示例

除了加载类上面 还可以加在方法上

在IDEA中 只要打了 /** 然后回车 就行了 会自动生成的 比如 返回什么 抛出了什么异常

然后是记住那几个@单词的说明 比如 @autor 是作者 @since是指明的jdk版本号 等等

-----------------------------------

前面在命令行有java javac这些命令

我们把这个文件的文件夹打开 然后打开命令行 也是可以使用javadoc命令的

如果不知道javadoc命令的具体使用 我推荐大家要有个基本的概念 就是加上 --help 之类的查看怎么用

比如javadoc --help

就有怎么加参数的教学了

那么比如我们根据命令行的提示输入

javadoc -encoding UTF-8 -charset UTF-8 Doc.java -d E:/javadoc

那么就生成在E盘的javadoc这个目录下了 然后看看这个目录多了什么

打开index.html 就能看到我们写的东西的说明文档了 很方便

这个是使用命令行 使用IDEA也可以 IDEA这个工具大家还是不要汉化的比较好 还是自己去看看能不能看懂 然后找下这个工具

比如IDEA的方法在tools菜单里 

打开就有这样的提示

比如我把一些东西填上

 就是这样

方法有很多 比如在文件右击打开终端 这个终端的路径也是这个文件夹的路径 也是可以输入命令生成文档的 写python 有时候就是右键打开终端 然后pip conda什么的安装包什么的

输入命令主要是要加 -encoding UTF-8 -charset UTF-8 因为这个对中文友好 

下一篇是java的Scanner 使用 就是怎么键盘输入什么的 怎么进行用户交互