=
=
节约重复注释
使用@inheritDoc
使用@see
=
Java文档注释用法+JavaDoc的使用详解
文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释。
注意:文档注释必须写在类、接口、方法、构造器、成员字段前面,写在其他位置无效。
JavaDoc 官方说明
How to Write Doc Comments for the Javadoc Tool
原文:https://blog.csdn.net/lsy0903/article/details/89893934
一般段落都用p标签来标记,凡涉及到类名和方法名都用@code
标记,凡涉及到组织的,一般用a标签提供出来链接地址。
@param
一般类中支持泛型时会通过@param
来解释泛型的类型
package java.util;
/**
* @param <E> the type of elements in this list
*
*/
public interface List<E> extends Collection<E> {}
@author
详细描述后面一般使用@author
来标记作者,如果一个文件有多个作者来维护就标记多个@author
,@author
后面可以跟作者姓名(也可以附带邮箱地址)、组织名称(也可以附带组织官网地址)
// 纯文本作者
@author Rod Johnson
// 纯文本作者,邮件
@author Igor Hersht, igorh@ca.ibm.com
// 超链接邮件 纯文本作者
@author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>
// 纯文本邮件
@author shane_curcuru@us.ibm.com
// 纯文本 组织
@author Apache Software Foundation
// 超链接组织地址 纯文本组织
@author <a href="https://jakarta.apache.org/turbine"> Apache Jakarta Turbine</a>
@see 另请参阅
@see
一般用于标记该类相关联的类,@see即可以用在类上,也可以用在方法上。
/**
* @see IntStream
* @see LongStream
* @see DoubleStream
* @see <a href="package-summary.html">java.util.stream</a>
* /
public interface Stream<T> extends BaseStream<T, Stream<T>> {}
@since 从以下版本开始
@since
一般用于标记文件创建时项目当时对应的版本,一般后面跟版本号,也可以跟是一个时间,表示文件当前创建的时间
package java.util.stream;
/**
* @since 1.8
*/
public interface Stream<T> extends BaseStream<T, Stream<T>> {}
package org.springframework.util;
/**
* @since 16 April 2001
*/
public abstract class StringUtils {}
@version 版本
@version
用于标记当前版本,默认为1.0
package com.sun.org.apache.xml.internal.resolver;
/**
* @version 1.0
*/
public class CatalogManager {}
@deprecated
@deprecated
用于标注一个类或成员已过期,通常配合{@link}
使用
/**
* @deprecated as of 5.0.4, in favor of {@link Locale#toLanguageTag()}
*/
@Deprecated
public static String toLanguageTag(Locale locale) {
return locale.getLanguage() + (hasText(locale.getCountry()) ? "-" + locale.getCountry() : "");
}
@see
@see
既可以用来类上也可以用在方法上,表示可以参考的类或者方法
/**
* @see java.net.URLDecoder#decode(String, String)
*/
public static String uriDecode(String source, Charset charset) {}
@value
{@value}
用于标注在常量上用于表示常量的值
/** 默认数量 {@value} */
private static final Integer QUANTITY = 1;
@inheritDoc
@inheritDoc
用于注解在重写方法或者子类上,用于继承父类中的Javadoc
- 基类的文档注释被继承到了子类
- 子类可以再加入自己的注释(特殊化扩展)
- @return @param @throws 也会被继承
原文:https://blog.csdn.net/lsy0903/article/details/89893934
=
=
=
相关推荐
电影院售票项目源代码(完整注释+javadoc),使用序列化反序列化工具,各种异常完整捕获,希望大家喜欢,共同学习
java编码规范及注释快捷键.doc
Twaver最新开发学习包,有需要的童鞋,尽管下载吧。
Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、...
使用Javadoc生成Java API文档的方法
非常标准的javadoc注释文档,值得试用
本项目是IntelliJ IDEA的插件,能帮助java开发者自动生成javadoc文档注释
具体内容可参阅主页文章:【2023,学点儿新Java-09】Java初学者常会犯的错误总结与解决方案 | Java中的注释类型 | 详细教学:通过命令行 执行 Java中特有的文档注释
javadoc利用Java编译程序javac对程序代码源文件中的声明和文档注释进行语法分析,并在默认情况下生成一组HTML文档来描述类、内部类、接口、构造函数、方法和域。不过在运行过程中,它也使用了Java平台的环境变量...
使用Eclipse生成javadoc文档的方法
JavaDoc工具 解析Java源码注释,生成api文档、接口文档
赠送jar包:flink-java-1.13.2.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
svnkit 1.8.11- javadoc(svn java编程文档)
赠送jar包:javacv-1.5.7.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
Java事务服务拓扑套件-开发者指南
赠送jar包:javacv-1.5.5.jar;...使用方法:解压翻译后的API文档,用浏览器打开“index.html”文件,即可纵览文档内容。 人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
一个非常棒的Javadoc注释工具 ,相当经典。
对于Javadoc的自动生成网住文档的具体使用方法
JavaDoc生成API文档(powernode...Java中有三种注释方法://单行注释、/多行注释/和/文档注释/,其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。我们可以通过Eclipse来实现Java文件的API文档生成。
从Java源代码创建Swagger文档的通常方法是注释。 但是它们有一些问题。 首先,将Swagger批注编译到服务器的JAR / WAR中,并占用磁盘空间。 第二,它们看起来不好。 第三,如果同时使用Javadoc和Swagger注释来记录...