javadoc生成注释文档

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/ron03129596/article/details/53353420

javadoc生成注释文档

今天闲着没事无意间看到注释了这一块了,想着javadoc命令可以生成开发中的注释文档,之前在工作中一直没有使用过,想着特地来实验下。

在平时java开发中我们为了增强代码的可读性会经常写注释,这也是一个非常好的习惯,因为如果没有注释隔断时间来看自己写的代码一定是懵逼状态,看别人写的代码就更不用说了,所以注释是个很不错的东西。

注释有单行、多行/块、文档注释,以及其中的注解语法,这里就不多说了直接进入生成文档的正题。


首先、我们先编写一个类里面写上相应注释:如下


接下来、我们找到相应的文件夹下运行命令行执行,这里呢我本想执行javac进行编译的,却出现了如下编译错误


有问题就得解决吖,解决方案如下

原执行命令 javac App.java
看了开发工具下的编码格式为UTF-8,所以现执行命令如下 javac –encoding UTF-8 App.java,
就编译正常了

下面进行文档的生成 执行命令:javadoc -encoding UTF-8 -d user_service -author -version App.java

javadoc为jdk提供的工具jar

-encoding UTF-8是因为我的编码格式出现了冲突

-d user_service是指在当前命令文件夹下创建user_service文件夹,并在该文件夹下生成文档

-author 是指作者

-version是版本


执行结果如下:



文档结构如下:


index.html内容如下:


是不是增加了代码的专业性呢,都是本人亲自试验,如有问题欢迎各位朋友提出,及时改正,谢谢

猜你喜欢

转载自blog.csdn.net/ron03129596/article/details/53353420