多人团队协作开发的时候经常会出现冲突,一般的做法是善用协作工具如git、svn等。但是这也只能保证代码不冲突,无法校验代码正确性,有可能出现下一个拉取代码的人无法运行。我本人做的是java,无意中发现两个有意思的Javadoc注解:@link和@see。
1. @see
/**
* 对上述接口做aop拦截,记录到操作日志里面
*
* @see com.demo.its.controller.UserController#login(String, String)
* @see com.demo.its.controller.TreeController#getTree(String)
*/
public void doManageLogAfter(JoinPoint joinPoint) {
// do some codes
}
语法格式:
@see 全路径包名#方法名(参数类型列表)
一般用在方法上面,可以直接点击进入对应的方法上,如果调用方法被篡改了,注释会报红,起到一个提示作用。
此注解要在注释里面顶头写,否则无效。
调用正常
调用有错
不顶头无效
2. @link
/**
* 对上述接口做aop拦截,记录到操作日志里面
* <p>
* {@link com.demo.its.controller.UserController#login(String, String)}
* {@link com.demo.its.controller.TreeController#getTree(String)}
*/
public void doManageLogAfter(JoinPoint joinPoint) {
// do some codes
}
语法格式:
{@link 全路径包名#方法名(参数类型列表)}
同上,用在方法上,唯一区别是可以不用顶头写,推荐此种写法👍
调用正常
调用有错
不顶头也可以
网友评论