java - 从用户那里收到价值时，正确的评论方式是什么？

Question

我正在尝试学习 Java 中正确的代码格式、约定、保持整洁并添加正确的注释。

然而，当我调用 JOptionPane 输入对话框以“接收”用户指定的值时，我对应该使用什么措辞感到困惑。

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

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

Answer 1

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

• 如果您无法理解代码的作用，则代码可能很糟糕。
• 如果您了解代码但不了解执行特定操作的原因，则您缺少注释。

因此，与其添加像// read user input您这样的注释，不如以一种有用的方式命名您的方法和变量：

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

无需评论即可理解这一点。

Answer 2

不要过分强调评论的确切语言。你只是想让他们清楚，这样在你身后维护代码的人就会明白发生了什么。不要担心注释的语法，它真的没那么重要。

你可以说：

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

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

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

:)