1

我正在编写一个包含大量按钮、文本区域和文本字段的 gui 程序,所有这些都带有一个或多个 actionListener,我总共有大约 50 个。

是否每个都需要 javaDoc 级别的注释,或者 actionListener 方法是否有不同的标准?

谢谢

4

1 回答 1

2

由于其他人不太可能使用您的课程,因此只有您才能看到 javadocs。在这种情况下,重要的是退后一步考虑以下问题:

  • 我能理解一切的含义吗?
  • 如果我在 5 年后回来,我能理解这一切意味着什么吗?

如果您自己工作,则不一定需要包含 javadocs,但至少要包含简洁、信息丰富的注释//progress bar for download,告诉您什么是什么。你不需要为每件事重述你的方法和操作集,只要确保你可以自己阅读它,如果你忘记了某些东西是如何工作的。

于 2013-08-13T14:10:57.953 回答