文档注解

拼搏现实的明天。 2022-09-20 11:12 128阅读 0赞

文档注解中使用的标签：

@author：可以指定被标注类或者方法的作者。在一个文档注解中可以使用多个author标签

例如：@author name

[\{@code][code]\}：利用code标签以代码字体显示文本

例如：[\{@code<b>StringUtil</b][code_b_StringUtil_b]>\}会输出<b>StringUtil<b>

[\{@docRoot][docRoot]\}：指定所生成文档的根目录

例如：<a href=[\{@docRoot][docRoot 1]\}/help.html>点击</a>

@deprecated:致命已弃用的类型或者方法

@exception：在文档注解中对方法或者构造器使用@exception。以指明该方法会抛出异常

例如：

/\*\*

@thorws java.io.FileNotFoundException.如果文件找不到。

\*/

public void openFile(String fileName) \{\}

@exception 和 @thows是相同的

[\{@inheritDoc][inheritDoc]\}：

[\{@link][link]\}：插入一个HTML超链接，它引用指定包、类的文档，或者被引用类的成员名称

[\{@linkplain][linkplain]\}:该标签与[\{@link][link]\}标签相似

[\{@literal][literal]\}：如果要显示文本，并且将文本中的所有特殊字符都进行转义，那么可以使用该标签。

@param:该标签描述一个方法或者一个构造器的参数

例如：param 描述元素 描述

@return：该标签描述一个方法的返回值

例如：@return 描述

@see:利用这个标签添加一个seeAlso项，它后面可以带一个引用某个资源的文本条目或者链接

例如：

@see text：没有生成超链接

@see link：后面生成一个超链接

@see package。class\#number label

@serial：这个标签描述一个默认的可序列化域

@serialDate :描述序列化表单中的数据类型和数据顺序

@serialFild：描述serializable类的serialPersistentFilds成员的一个ObjectStreamField组件

@since:用指定参数添加一个since表头

例如：@since text

@throws ：与@exception相同

@value

@version

[code]: mailto:%7b@code
[code_b_StringUtil_b]: mailto:%7b@code<b>StringUtil</b
[docRoot]: mailto:%7b@docRoot
[docRoot 1]: mailto:%7b@docRoot%7d/help.html
[inheritDoc]: mailto:%7b@inheritDoc
[link]: mailto:%7b@link
[linkplain]: mailto:%7b@linkplain
[literal]: mailto:%7b@literal

发表评论取消回复

表情：

评论列表（有 0 条评论，128人围观）

还没有评论，来说两句吧...

相关阅读

相关利用Java注解实现代码自文档化

在Java中，我们可以使用注解来增加代码的自文档性。以下是一个简单的例子，我们创建一个注解来标记方法的用途： ```java // 定义注解 @Retention(Reten

待我称王封你为后i/ 2024年12月05日 20:45/ 0 赞/ 3 阅读

相关 Java注解：API文档生成与解析问题

在Java编程中，注解是一种自定义的元数据形式。它们主要用于提供关于类、方法、字段等的附加信息，比如作者、版本、描述等。要解决API文档生成与解析的问题，可以遵循以下步骤：

拼搏现实的明天。/ 2024年09月16日 06:03/ 0 赞/ 70 阅读

相关 POI自定义注解生成文档

、环境搭建：  <dependency> <groupId>org.apache.poi</grou...

向右看齐/ 2024年04月19日 14:53/ 0 赞/ 67 阅读

相关 java 注解官方文档_Java 注解指导手册（下）

原标题：Java 注解指导手册(下) (点击上方公众号，可快速关注) 来源：Toien Liu， ifeve.com/java-annotations-tutorial/

超、凢脫俗/ 2022年11月10日 04:58/ 0 赞/ 120 阅读

相关文档注解

文档注解中使用的标签： @author：可以指定被标注类或者方法的作者。在一个文档注解中可以使用多个author标签例如：@author name [\{@code][

拼搏现实的明天。/ 2022年09月20日 11:12/ 0 赞/ 129 阅读

相关 MyBatis 注解（摘自MyBatis官方文档）

<table style="max-width:100%; border-collapse:collapse; border-spacing:0px; width:1150px

系统管理员/ 2022年08月26日 00:58/ 0 赞/ 28 阅读

相关 WebService 通过注解修改wsdl文档

代码： Order.java package com.bean; import javax.xml.bind.annotation.Xml

女爷i/ 2022年06月10日 00:21/ 0 赞/ 316 阅读

相关 swagger2 注解说明文档

<table> <thead> <tr> <th>注解</th> <th style="width:145px;">属性</th> <th s

不念不忘少年蓝@/ 2022年05月08日 01:50/ 0 赞/ 353 阅读

相关 SpringMVC + Swagger注解生成Rest API在线文档简介

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。Swagger是世界上最大的API开发框架，它能使后端的接口形成API文档

小咪咪/ 2021年11月27日 05:02/ 0 赞/ 447 阅读

相关 webservice 修炼之文档注解说明（二）

前面我们讲了webservice的jdk下的开发模式，在进行对cxf的开发模式的学习之前，先看看wsdl文档和注解的相关知识。通过查询<ser

比眉伴天荒/ 2021年10月16日 00:34/ 0 赞/ 350 阅读