从用户接收值时，评论的正确方法是什么？

Question

我正在尝试在Java中学习正确的代码格式，约定，保持整洁并提出适当的注释。

但是，当我调用JOptionPane输入对话框以“接收”用户指定的值时，我会使用什么措辞，这令我感到困惑。

在这种情况下通常使用什么？

我正在使用“//获取用户输入”，但我刚刚阅读了一篇文章，解释说“获取”某些内容具有完全不同的含义。

Answer 1

在我看来，评论应该解释为什么你做某事（如果不明显）。代码本身应该告诉 它是如何完成的。

• 如果您无法理解代码的作用，那么代码可能会很糟糕。
• 如果您了解代码但不理解为何执行特定操作，则表示您缺少评论。

因此，您应该以有用的方式命名您的方法和变量，而不是添加// read user input之类的注释：

...
String userInput = getUserInput(); 
...

无需理解这一点。

Answer 2

不要过分强调评论的确切语言。你只是希望它们清楚，以便谁来支持你维护代码将了解正在发生的事情。不要担心评论的语法，它确实不那么重要。

你可以说：

//get user input
//read user input
//take user input

老实说，这是最不重要的事情之一。只要确保人们知道你在做什么。我专注于使代码本身干净，格式良好，而不是评论。发表评论很重要，因为大多数程序员都没有花时间去做，但这不是最重要的事情。

在命名方法/类/函数/变量时，更重要的是要注意你的措辞。不是评论。

:)