我是否需要在java中使用javadoc每个方法或只是'main'方法？

Question

Java示例方法：

//Stores the user input into an integer variable called 'choice'
int choice = keyboard.nextInt();

我是否需要为这样的简单方法编写javadoc，或者我应该只记录任何程序的主要方法，如果是，那么我应该为main方法编写什么样的东西？

谢谢，

克里斯。

Answer 1

您的其他帖子解释了这一点： What should I write in my javadoc class and method comments?

您发布的内容也不是一种方法。即使是作业，也不需要对每行代码进行注释。如果您有明显的事情，例如：

i++;

您无需使用“逐个增量”对其进行评论。

同样，代码注释（包括JavaDoc）不会影响代码的执行。

Answer 2

需要？这取决于你所说的“需要”。

我认为你的问题有一些混乱。其中之一就是构成一种方法。你好像在询问一般的评论。 Javadocs是一种特定的注释形式（具有特定的语法）。另外，一个狡辩：上面的例子不是一个方法。这是一行代码。

但只是解决这个问题，我不会使用那个评论。 显然你正在设置一个名为“choice”的变量。唯一有趣的是nextInt做了什么，但是任何好奇的人都应该能够将鼠标悬停在nextInt（）方法上并查看其javadoc。

Answer 3

首先，该示例不是javadoc，只是代码注释

这是一个关于javadoc的教程 How to write javadoc

你应该只是javadoc面向公众的方法