Gau*_*tam 1 java eclipse tags coding-style
我注意到Eclipse会自动@author
在新Java类的顶部添加一个带有我名字的标签.我也注意到,有可像其他标签@version
,@link
,@code
,@value
,@see
...
是否只是形成了另一个"惯例",以便代码保持良好的记录?还是有其他目的吗?
我试图找到一个网站,可以更好地描述标签及其用法,但我没有运气.
这些是与Javadoc机制相关的Javadoc标记.当您生成Javadoc(Eclipse菜单中有一个选项)时,这些链接将被正确解释,Javadoc将更加详细.请参阅注释中的链接以获取所有可用标记的列表.
低估你不会的文档的力量.