2011-11-28 54 views
1

我注意到Eclipse自动添加了一个@author标签,它的名称位于新Java类的顶部。我也注意到,有可像其他标签@version@link@code@value@see ...Eclipse标签的用途是什么 - 像@author,@version,@link?

难道只是已经形成,使得代码中的另一个“公约”保持良好的记录?还是有其他目的?

我试图找到一个网站,可以给出更好的描述标签和他们的用法,但我没有任何运气。

+8

这些是javadoc标签。 http://docs.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#javadoctags – evan

+0

感谢您的链接。这真的有帮助。 – Gautam

+2

@evan:我认为你可以详细阐述一下,然后将其作为答案发布。 – BoltClock

回答

6

这些是与Javadoc机制相关的Javadoc标签。当你生成Javadoc(在Eclipse菜单中有一个选项)时,这些链接将被正确解释,并且Javadoc将会更加详细。请参阅评论中的链接,了解所有可用标签的列表。

低估您不会记录的文档的力量。

+0

这些不是注释,但它们是javadoc标签。 –

+0

谢谢我只是在Java文档中查找它,你是对的,'注释补充javadoc标签'。我现在正在改变它。 – talnicolas