啥是Javadoc？

啊哈，Javadoc是啥呢？它就像是我们的说明书，Neng帮别人kan懂我们写的Java代码是干嘛的。就像是妈妈告诉我们不要把玩具乱扔一样，Javadoc就是告诉我们这玩意儿程序是怎么玩的。

读规范Neng学会吗？

当然Neng啦！就像学语文一样，读懂了规则，我们就Neng写出优良作文。Javadoc规范就像是语文的语法规则，学会了就Neng写出优良的代码说明书。

怎么写Javadoc呢？

写Javadoc要按照一定的格式来写哦，就像我们写字要写齐整一样。比如说我们在写一段话之前要写一个开头，然后写上我们的名字，这样别人就晓得这是谁写的了。

比如说 我们要写一个方法的说明，我们就Neng这样写：

/**

* 这是一个方法的说明

* @param 参数名 参数的说明

* @return 返回值的说明

*/

kan例子学写Javadoc

来来来kan一个例子吧：

public class Hello { public void sayHello { System.out.println; } } 对应的Javadoc就是： /** * 这玩意儿类用来打招呼 * @author 细小明 */ public class Hello { /** * 打印出问候语 * @param name 人的名字 */ public void sayHello { System.out.println; } } 学以致用 学会了Javadoc规范，我们就要把它用在实际的项目中。

写完代码之后想起来加上Javadoc哦，这样别人kan我们的代码就像kan故事一样轻巧松。 所以阅读Javadoc规范，当然Neng飞迅速掌握Java文档注释技巧啦！就像我们学会了语法规则，就Neng写出优良作文一样，学会了Javadoc规范，我们就Neng写出优良代码说明书。 优良啦，今天的分享就到这里下次我们再聊聊其他好玩的编程话题吧！