• javadoc


    使用Javadoc标记

           Javadoc标记是插入文档注释中的特殊标记,它们用于标识代码中的特殊引用。javadoc [email protected]组成。记住了,三个部分——@、标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔,但是推荐将它们紧挨着写,以减少出错机会。

           javadoc 标记有如下一些:

    常用的JavaDoc标签:

    标签 说明 JDK 1.1 doclet 标准doclet 标签类型
    @author 作者 作者标识 包、 类、接口
    @version 版本号 版本号 包、 类、接口
    @param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释。 构造函数、 方法
    @return 描述 对函数返回值的注释 方法
    @deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、 方法
    @throws异常类名 构造函数或方法所会抛出的异常。   构造函数、 方法
    @exception 异常类名 同@throws。 构造函数、 方法
    @see 引用 查看相关内容,如类、方法、变量等。 包、类、接口、值域、构造函数、 方法
    @since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、 方法
    {@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。   包、类、接口、值域、构造函数、 方法
    {@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。   √(JDK1.4) 静态值域

     

     

    下面详细说明各标记。

     

     

     

    1. @see 的使用

    @see 的句法有三种:

    @see   类名

    @see #  方法名或属性名

    @see   类名#方法名或属性名

     

    
    
  • 相关阅读:
    敏捷软件开发——迭代计划版本号
    01背包问题
    南邮算法分析和实验设计1 分而治之
    PowerShell与Unix Shell对比:八大实例
    grep、sed、awk、perl、js、vim等对正则表达式的支持的差别
    perl的一些基本用法
    Lua学习笔记1
    在eclipse中建立lua开发环境
    MYSQL设置远程账户登陆总结,mysql修改、找回密码、增加新用户,MySQL数据库的23个注意事项
    LuaForWindows_v5.1.4-45和lua-5.1.4.tar.gz
  • 原文地址:https://www.cnblogs.com/liehuonanjue/p/7348863.html
Copyright © 2020-2023  润新知