为javafx应用程序编写javadocs有什么意义吗？

Question

这里的简单问题。将javadocs应用于javafx应用程序中的方法是否有任何意义。

对于初学者 - 我的大多数方法标题格式为private（带@FXML注释）。 我使用了一些public方法 - 但如果最终用户使用javadocs与应用程序进行交互而我的应用程序不是{{1}，那么GUI中的要点是什么？ }}？显然，我的所有方法都得到了简明扼要的评论 - 但我不知道API对用户或未来代码开发人员有什么好处。

我错了吗？如果是这样，我非常感谢您对此的看法。 非常感谢。

Answer 1

请查看https://softwareengineering.stackexchange.com/questions/85910/is-it-wrong-not-to-create-javadoc-for-my-code

理论上，有意义的文档从来都不是坏事，因此，您应该以有意义的方式记录每一种方法。

在实践中，它取决于文档的“受众”，团队协议和个人选择。

需要考虑的事项是：

1. 您的受众可以成为维护开发人员，在没有工作或访问项目3年之后，忘记了其他人 可能是您自己 这一切的细节。
2. 对于Javadoc和类似的文档工具和标准，即使对于私有方法（默认情况下通常不会输出到外部doc文件），许多IDE支持Javadoc（或类似）并基于它们实现额外功能。例如，NetBeans可以显示包含类型，名称的工具提示，如果您记录了它们，则可以显示类，方法以及输入和输出参数和变量的用途。 如果您忘记了某些内容，则无需打开文件和/或查看源代码内联注释 。

Answer 2

对于框架代码，我总是Javadoc所有公共和受保护的成员。对于应用程序代码，我通常不打扰Javadoc注释，但我确实使用内联注释来解释方法正在做什么。

对于私有方法（无论是框架还是应用程序代码），我根本不使用Javadoc，因为默认情况下它们不包含在Javadoc输出中。不过，我确实对私人会员使用内联评论。