我是否需要javadoc每一种方法或只是在java中的'主要'方法？

Question

Java示例方法：

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

我是否需要写的javadoc像这样的简单的方法，或者我应该只是文件的任何程序的主要方法，如果这样的话，我应该写什么样的东西主方法？

谢谢，

Chris。

Answer 1

需要？这取决于你的意思是“需要”。

我认为你的问题存在一些困惑。其中之一是什么构成一种方法。你似乎总是在询问有关评论。 Javadocs是特定的注释形式（使用特定的语法）。此外，一个狡辩：你上面的例子不是一种方法。这是一行代码。

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

Answer 2

这在其他线程解释： What should I write in my javadoc class and method comments?

什么你已经张贴不是方法无论是。即使是作业，您也不需要评论每一行代码。如果你有什么明显的如：

i++; 

你不需要评论它与“增量我一”。

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

Answer 3

首先，这个例子是不是javadoc的，只是一个代码注释

这里是javadoc的 How to write javadoc

教程，您应该只javadoc的面向公众的方法