Java新手 - 一般JavaDoc问题

Question

一般JavaDoc问题： 我怎么知道他们是否在工作？我知道格式和他们应该做的事情，但我怎么知道他们是否正在做他们的工作？它应该在编译和运行后打印出来吗？

另一个问题 - 我需要多少JavaDoc评论？我的教授真的希望我们在这些评论中检查我们的方法，并解释任何变量。这是否意味着将它放在方法中？或者在方法之前但在课堂内？还是在上课之前？

感谢您的帮助！

Answer 1

我认为你可能会对JavaDoc实际做的事情感到有点困惑。

无论如何，JavaDoc都不会直接影响您的程序。 JavaDoc是一种编译程序信息的方法。假设您获得了一个程序，并希望以一种非常方便的格式记录它的功能。像eclipse这样的常见编译器可以选择编译一个充满文档的html文件，就像它在Java API文档中所显示的那样。 https://docs.oracle.com/javase/7/docs/api/ 这大部分都是JavaDoc，它是通过注释生成的。

我的老师总是在评论方面告诉我，你不会评论那些不读代码的人。你不需要像....那样的评论。

// Prints out hello world
System.out.println("hello world");

程序员已经知道这个功能。程序员对参数名称以及实际执行的功能更感兴趣。实施例

/**
* @param a Number we are dividing into
* @param b Number we are dividing by
* @return Our quotient
*/
public static float divide(int a, int b) {
return (a/b); }

会生成这样的页面 强调顶部的/ **，两个星号表示下面包含JavaDoc。大多数IDE都像Eclipse一样会突出显示JavaDoc。 正如您所看到的，参数的名称只是a和b，在某些情况下，很难根据函数的功能标记参数名称，因此可以节省使用JavaDoc来描述它们的时间，而不是某些人滚动你的代码试图找出他们到底做了什么。您正在为程序创建指南以修改和更新它。

JavaDoc实际上是指导您的所有函数，类，变量在程序中如何工作的指南。