记录actionListeners的最佳实践

时间:2013-08-13 14:06:57

标签: java coding-style awt action actionlistener

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

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

由于

1 个答案:

答案 0 :(得分:2)

由于其他人不太可能使用你的课程,你只有你才能看到javadocs。在这种情况下,重新回过头来考虑以下事项:

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

如果您自己工作,则不一定需要包含javadoc,但至少需要简明扼要的信息,例如//progress bar for download,告诉您什么是什么。您不需要为所有内容重新设置一组方法和操作,只要确保您可以在忘记某些工作方式的时候自己阅读它。