javadoc 常用的几个注释栗子

在日常的Java开发过程中。如图，修改以下四个地方，基本满足开发的备注注释了：

贴出代码：

Files：

/**
 * @description ${todo}
 * @author ${user} 
 * @createTime ${date} ${time} 
 * @version 1.0.0 
 */

Types：

/**
 * @description ${todo}
 * @author ${user} 
 * @createTime ${date} 
 * @version 1.0.0 
 */

Methods：

/**
 * @description ${todo} 
 * ${tags} 
 */

Overriding methods：

/**
 * @description ${todo} 
 * ${tags} 
 * ${see_to_overridden}
 */

最后结果为：

package com.on.ido.eureka.server.a.a.a;

/**
 * 
 * @description TODO 
 * @author Administrator
 * @createTime 2018年1月11日
 * @version 1.0.0
 */
public interface B {
/**
* 
* @description TODO
* @param aa
* @param bb
* @return
*/
String aaa(String aa, Integer bb);
}

package com.on.ido.eureka.server.a.a.a;


/**
 * 
 * @description TODO
 * @author Administrator
 * @createTime 2018年1月11日
 * @version 1.0.0
 */
public class A implements B {
/**
* 
* @description TODO
* @param aa
* @param bb
* @return
* @see com.on.ido.eureka.server.a.a.a.B#aaa(java.lang.String,
*      java.lang.Integer)
*/
@Override
public String aaa(String aa, Integer bb) {
return "";
}
}