我知道有一个可以使用“ <移> J”为一个单码元(例如类方法)创建的标签。

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

有帮助吗?

解决方案

你有没有看着 JAutodoc

其他提示

不,我知道的。

什么是将反正是好?自动生成javadoc注释是有害无益;我宁愿没有它们塞满了我的代码,而Javadoc将提供尽可能多的信息,即使目前没有评论。

自动生成的Javadoc是一种痛苦,因为别人从来没有现在什么方法应该做的和你自己也不会知道,当你在类很一年后。

请自行评论你的方法还是不要评论的方法。

我公司使用的CheckStyle迫使雇主增加的javadoc。有些雇主恨它,评论他们的方法和只需输入sensless意见。这将是更好,他们比没用任何评论。

使用的CheckStyle你可以找到所有的无证方法,在一个良好的格式来记录他们。

什么可以帮助您记录像一个init方法

  

“初始化之前具有任何要调用   其它方法和初始化类   ActionDummy“

这是更好地告诉究竟是什么做

  

Inizializes的默认状态   行动提供商。一些状态变量可以   由听者重写时....

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top