Java 从用户处收到值时，正确的注释方式是什么？

我正在努力学习Java中正确的代码格式、惯例、保持整洁和适当的注释

然而，当我调用JOptionPane输入对话框以“接收”用户指定的值时，我不知道应该使用什么措辞

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

---

我正在使用“//Get user input”，但我刚刚读了一篇文章，解释了“获取”某种东西有着完全不同的含义

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

你可以说：

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

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

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

---

：）

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

• 如果您无法理解代码的功能，那么代码可能是错误的
• 如果您理解代码，但不理解执行特定操作的原因，则缺少注释

因此，与其添加类似于

//read user input

的注释，不如以一种有用的方式命名方法和变量：

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

---

不需要任何注释就可以理解这一点。

我认为

//获取用户输入

实际上很好。我也经常写

//读用户输入

，但我认为两者都可以。“获取用户输入”似乎很好。“Get”也经常出现在用于访问私有变量的“getter”类型的方法中，但我认为它不会引起混淆。还有“提示用户输入”、“获取用户输入”等，但我只想离开“获取”，继续您的业务。谢谢您的评论！我现在就坚持用Get。大家干杯！谢谢我将确保了解更多关于保持代码干净和格式良好的信息。干杯没问题，伙计！注释很重要，更多的程序员应该使用它们，但同样，不要挂断注释中使用的特定单词。应该为方法/类/变量保留。你的心在正确的地方，只要把努力放在正确的地方：）