为 javafx 应用程序编写 javadoc 有什么意义吗？
Is there any point in writing javadocs for a javafx application?
这里是一个简单的问题。将 javadocs 应用于 javafx 应用程序中的方法有什么意义吗？
对于初学者 - 我的大部分方法 headers 都被格式化为 private（带有 @FXML 注释）。
我正在使用一些 public 方法 - 但如果最终用户使用 GUI 与应用程序交互而我的应用程序不是 API，那么 javadocs 有什么意义？显然，我的所有方法都有简洁的注释 - 但我看不出 javadocs 对代码的用户或未来开发人员有什么好处。
我错了吗？如果是这样，我将非常感谢您对此的看法。
非常感谢。
从理论上讲，有意义的文档从来都不是坏事，因此您可以以有意义的方式记录的每一种方法都应该记录下来。
在实践中，归结为文档的 "audience" 是谁、团队协议以及个人选择。
需要考虑的事项是：
- 你的听众可以是维护开发人员，不管其他人，可能是你自己，在 3 年没有工作或访问之后项目，在你忘记了它是如何工作的细节之后。
- 对于 Javadoc 和类似的文档工具和标准，即使对于私有方法（默认情况下通常不会输出到外部 doc 文件），许多 IDE 都支持 Javadoc（或类似的）并基于它们实现额外的功能。例如，NetBeans 可以显示工具提示，其中包含类型、名称，如果您记录了它们，类 的用途、方法以及输入和输出参数和变量。 消除打开文件的需要and/or查看源代码内联注释如果您忘记了什么。
对于框架代码，我总是 Javadoc 所有 public 和受保护的成员。对于应用程序代码，我通常不会理会 Javadoc 注释，但我会使用内联注释来解释方法的作用。
对于私有方法（无论是框架还是应用程序代码），我根本不使用 Javadoc，因为默认情况下它们不包含在 Javadoc 输出中。不过，我确实为私人成员使用内联评论。
这里是一个简单的问题。将 javadocs 应用于 javafx 应用程序中的方法有什么意义吗？
对于初学者 - 我的大部分方法 headers 都被格式化为 private（带有 @FXML 注释）。
我正在使用一些 public 方法 - 但如果最终用户使用 GUI 与应用程序交互而我的应用程序不是 API，那么 javadocs 有什么意义？显然，我的所有方法都有简洁的注释 - 但我看不出 javadocs 对代码的用户或未来开发人员有什么好处。
我错了吗？如果是这样，我将非常感谢您对此的看法。 非常感谢。
从理论上讲，有意义的文档从来都不是坏事，因此您可以以有意义的方式记录的每一种方法都应该记录下来。
在实践中，归结为文档的 "audience" 是谁、团队协议以及个人选择。
需要考虑的事项是：
- 你的听众可以是维护开发人员，不管其他人，可能是你自己，在 3 年没有工作或访问之后项目，在你忘记了它是如何工作的细节之后。
- 对于 Javadoc 和类似的文档工具和标准，即使对于私有方法（默认情况下通常不会输出到外部 doc 文件），许多 IDE 都支持 Javadoc（或类似的）并基于它们实现额外的功能。例如，NetBeans 可以显示工具提示，其中包含类型、名称，如果您记录了它们，类 的用途、方法以及输入和输出参数和变量。 消除打开文件的需要and/or查看源代码内联注释如果您忘记了什么。
对于框架代码，我总是 Javadoc 所有 public 和受保护的成员。对于应用程序代码，我通常不会理会 Javadoc 注释，但我会使用内联注释来解释方法的作用。
对于私有方法（无论是框架还是应用程序代码），我根本不使用 Javadoc，因为默认情况下它们不包含在 Javadoc 输出中。不过，我确实为私人成员使用内联评论。