可以自动为整个Eclipse项目创建javadoc标签吗?

时间:2009-07-16 07:50:53

标签: java eclipse javadoc autocreate

我知道可以使用'< alt>< shift> J'为单个代码元素创建标记(例如类方法)。

但是有没有办法为整个项目中的每个类自动创建这些标记?甚至只是在包装或班级?

3 个答案:

答案 0 :(得分:3)

你看过JAutodoc吗?

答案 1 :(得分:2)

不是我知道的。

无论如何,这会有什么好处?自动生成的Javadoc评论比无用的更糟糕;我宁愿不让它们弄乱我的代码,Javadoc会提供尽可能多的信息,即使没有评论。

答案 2 :(得分:2)

自动生成的JavaDoc是一种痛苦,因为当你在一年后查看课程时,其他人现在从来都不知道该方法应该做什么,而你自己也不会知道它。

请自行评论您的方法或不评论该方法。

我公司正在使用checkstyle强制雇主添加javadoc。一些雇主讨厌评论他们的方法,只是输入无意义的评论。如果他们没有评论而不是无用,那就更好了。

使用checkstyle,您可以找到所有未记录的方法,以井格式记录它们。

什么可以帮助您记录像

这样的init方法
  

“必须在任何之前调用init   其他方法并初始化类   ActionDummy“

最好告诉究竟做了什么

  

初始化的默认状态   行动提供者。一些状态变量可以   在......时被听众覆盖。