提升代码幸福感的小技巧之java中的@see与@link

   多人团队协作开发的时候经常会出现冲突,一般的做法是善用协作工具如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 全路径包名#方法名(参数类型列表)}

   同上,用在方法上,唯一区别是可以不用顶头写,推荐此种写法👍


调用正常

调用有错

不顶头也可以
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1. 简介 1.1 什么是 MyBatis ? MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的...
    笨鸟慢飞阅读 5,643评论 0 4
  • 从百度文库下载下来的,这里保存一份 别人的原代码程序员怎样阅读 源码就是指编写的最原始程序的代码。 运行的软件是要...
    Albert陈凯阅读 3,419评论 0 15
  • 本文档讲述了Java语言的编码规范,较之陈世忠先生《c++编码规范》的浩繁详尽,此文当属短小精悍了。而其中所列之各...
    蚁前阅读 938评论 0 51
  • 第一部分 HTML&CSS整理答案 1. 什么是HTML5? 答:HTML5是最新的HTML标准。 注意:讲述HT...
    kismetajun阅读 27,736评论 1 45
  • 注:都是在百度搜索整理的答案,如有侵权和错误,希告知更改。 一、哪些情况下的对象会被垃圾回收机制处理掉  当对象对...
    Jenchar阅读 3,245评论 3 2