第1天：Javadoc

Intro

自从5年前第一次接触Java以来​​，我就听说过Javadoc。 但是我意识到，直到我写了这篇笔记，我仍然不理解Javadoc是什么。 起初，我认为Javadoc是可以打印或导出为PDF的Java文档。 是的，有关该程序的文档。 自动生成。 好吧，我不是100％错误。 但是我想念的是如何创建或留下一个好的Javadoc。

通常，开发人员会发表评论，并简要解释一行代码。 像Java中一样，我们使用“ //”或“ / ** * /”字符进行注释。 好吧，这不是我最近发现的Javadoc。 不仅如此。 哈哈对不起我的经验:)

Javadoc

当我们从其他类调用方法时，将出现一个小的弹出窗口，解释该方法的含义。 小小的弹出窗口，他们称之为JAVADOC〜

直到我找到有关该方法的简要说明，我才真正理解。 并意识到这是生成/编写注释成为Javadoc的正确方法。

How to write a good Javadoc

编写文档很重要。 非常简短地说明方法/类。 这样，下一位将阅读您的代码的程序员将了解您正在尝试编写的内容。

在方法上方，以/ **开头以打开块注释部分。 此评论部分可以应用html和markdown标记。 所以让它漂亮;）

Always include @param , @return, @throws in the Javadocs. It's important when calling this method, and have no idea how to use the method.

I learned that a @param has to be followed by explanation about the param itself. for example :
@param firstNumb the first number
@param secndNumb the second number

这样的事情。 用名词完成它。 有关如何编写好的Javadoc的详细信息，请参考下面的参考资料〜

References

• Oracle