JAVA——文档注释(javavdoc)通用注释-超链接@see与@link的使用

基本概念

@see：必须顶头写

@link：任意位置写

语法

1. @see

@see 标签允许用户引用其他类的文档。具体使用方式如下：
@see classname
@see fully-qualified-classname
@see fully-qualified-classname#方法名称
@see fully-qualified-classname#属性名称

    /*** 对上述接口做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 全路径包名#方法名(参数类型列表)}

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

JAVA——文档注释(javavdoc)通用注释-超链接@see与@link的使用相关推荐

java文档注解快捷键_javadoc注释快捷键
JavaDOC 注释使用方法目录前言一. Java 文档和 javadoc... "开始."*/"结束的是C语言风格的注释语句,在"/**...*/&qu ...
Java文档注释用法+JavaDoc的使用详解
Java文档注释+JavaDoc的使用详解简介文档注释负责描述类.接口.方法.构造器.成员属性.可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释. ...
java文档注释编写格式
java 文档注释在sun主页上有java文档注释的编写格式 How to Write Doc Comments for the Javadoc Tool http://java.sun.com/j ...
java文档注释详解
https://blog.csdn.net/houhj168/article/details/41146415 对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序--人们也需要 ...
Java文档注释（利用javadoc生成HTML文档）
目录: 1. 在代码中使用文档注释 2. 类注释 3. 方法注释 4. 域注释 5. 通用注释 6. 包与概述注释 7. 注释的抽取 1. 在代码中使用文档注释 Java 程序员在开发的过程中,或多或 ...
Java文档注释【自制API】
工具类的文档注释工具类:一般都定义成静态的,只提供工具方法,没有特定数据,不需要构建对象. 为了保证不让其他成员创建对象,将无参的构造函数设置为私有化即可. 源文件: @author 作者 @ver ...
IDEA JAVA文档注释和方法注释模板
IDEA JAVA文档注释和方法注释模板文档注释 #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${ ...
java文档注释报错,java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...
Java注释详解-Java文档注释生成Java API文档
Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档.Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/. ...

JAVA——文档注释(javavdoc)通用注释-超链接@see与@link的使用

基本概念

语法

1. @see

2. @link

JAVA——文档注释(javavdoc)通用注释-超链接@see与@link的使用相关推荐

最新文章

热门文章