java文档注释——生成帮助文档(1)

public demo1() {

}

/**

*返回String值的add方法

• @param a 加数

• @param b 被加数

• @return 经过if语句判断后返回的String值

*/

public String add(int a,int b){

if(a+b>10){

return “big”;

}else{

return “small”;

}

}

}

java中的注释方式

1. 行内注释用//

2. 多行注释/**/

3. 文档注释/** */

上面的例子用的是文档注释

有了这个注释后，就可以用javadoc工具来读取生成帮助文档

通常在代码的文档注释中，前几行是关于这个类，方法，变量的相关描述。比如描述这个方法的作用，变量的含义等

后面几行可以加上多个 @标签，每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

通常情况下，用的比较多的标签是这四个，如果想查阅更多的标签，可以去

https://www.runoob.com/java/java-documentation.html

文档注释写好后，就可以用javadoc生成帮助文档了

方式一、cmd

找到自己的java文件所在位置

最开始写javadoc

-d后面的参数是帮助文档的生成位置

-encoding后面的参数UTF-8是编码，如果不加上这个会导致无法识别中文

最后跟上要输入进javadoc的java文件

总结

就写到这了，也算是给这段时间的面试做一个总结，查漏补缺，祝自己好运吧，也希望正在求职或者打算跳槽的 程序员看到这个文章能有一点点帮助或收获，我就心满意足了。多思考，多问为什么。希望小伙伴们早点收到满意的offer! 越努力越幸运！

金九银十已经过了，就目前国内的面试模式来讲，在面试前积极的准备面试，复习整个 Java 知识体系将变得非常重要，可以很负责任的说一句，复习准备的是否充分，将直接影响你入职的成功率。但很多小伙伴却苦于没有合适的资料来回顾整个 Java 知识体系，或者有的小伙伴可能都不知道该从哪里开始复习。我偶然得到一份整理的资料，不论是从整个 Java 知识体系，还是从面试的角度来看，都是一份含技术量很高的资料。

然得到一份整理的资料，不论是从整个 Java 知识体系，还是从面试的角度来看，都是一份含技术量很高的资料。**

[外链图片转存中…(img-kcuGjM8x-1714374214332)]

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录