docs: 修改 javadoc 中的格式错误

This commit is contained in:
2025-06-08 13:08:45 +08:00
parent 336d99d4ba
commit 89acbecc5a
42 changed files with 32 additions and 80 deletions

View File

@@ -24,17 +24,15 @@
* 标识<b>静态工厂方法</b>。
* 《Effective Java》的 Item1 建议考虑用静态工厂方法替换构造器,
* 因而考虑有一个注解可以标记一下静态工厂方法,以和其它方法进行区分。
* </p>
*
* <h3>
* 2. {@link ReaderMethod} 和 {@link WriterMethod}
* </h3>
* <p>
* 分别标识<b>读方法</b>(如 getter或<b>写方法</b>(如 setter
* </p>
*
* <p>
* 最早是写了一个集合类,为了方便判断使用读写锁时,哪些情况下使用读锁,哪些情况下使用写锁。
* </p>
*
* <h3>
* 3. {@link UnsupportedOperation}
@@ -42,22 +40,19 @@
* <p>
* 标识该方法不被支持或没有实现,将抛出 {@link UnsupportedOperationException}。
* 为了方便在使用时,不需要点进源码,就能知道该方法没有实现。
* </p>
*
* <h3>
* 4. {@link Virtual}
* </h3>
* <p>
* Java 非 final 的实例方法,对应 C++/C# 中的虚方法,允许被子类覆写。
* Java 非 final 的实例方法,对应 C++/C&num; 中的虚方法,允许被子类覆写。
* {@link Virtual} 注解旨在设计父类时,强调该方法父类虽然有默认实现,但子类可以根据自己的需要覆写。
* </p>
*
* <h3>
* 5. {@link ValueObject}
* </h3>
* <p>
* 标记一个类,表示其作为值对象,区别于 Entity。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/

View File

@@ -27,7 +27,7 @@ import javax.annotation.Nullable;
/**
* {@link Ref} 包装了一个值,表示对该值的应用。
*
* <p>灵感来自于 C# 的 {@value ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:</p>
* <p>灵感来自于 C&num; 的 {@code ref} 参数修饰符。C&num; 允许通过以下方式,将值返回给调用端:</p>
* <pre>
* void Method(ref int refArgument)
* {
@@ -51,7 +51,7 @@ import javax.annotation.Nullable;
* <p>
* 当一个方法需要产生多个结果时,无法有多个返回值,可以使用 {@link Ref} 作为参数传入,方法内部修改 {@link Ref} 的值。
* 调用方在调用方法之后,使用 {@code getValue()} 获取结果。
* </p>
*
* <pre>
* String method(final Ref&lt;Integer&gt; intRefArgument, final Ref&lt;String&gt; strRefArgument) {
* intRefArgument.transformValue(i -&gt; i + 44);

View File

@@ -20,8 +20,8 @@
* <h3>1. Ref</h3>
* <p>
* {@link Ref} 包装了一个值,表示对该值的应用。
* </p>
* <p>灵感来自于 C# 的 {@value ref} 参数修饰符。C# 允许通过以下方式,将值返回给调用端:</p>
*
* <p>灵感来自于 C&num; 的 {@code ref} 参数修饰符。C&num; 允许通过以下方式,将值返回给调用端:</p>
* <pre>
* void Method(ref int refArgument)
* {
@@ -45,7 +45,7 @@
* <p>
* 当一个方法需要产生多个结果时,无法有多个返回值,可以使用 {@link Ref} 作为参数传入,方法内部修改 {@link Ref} 的值。
* 调用方在调用方法之后,使用 {@code getValue()} 获取结果。
* </p>
*
* <pre>
* String method(Ref&lt;Integer&gt; intRefArgument, Ref&lt;String&gt; strRefArgument) {
* intRefArgument.transformValue(i -&gt; i + 44);
@@ -65,7 +65,6 @@
* <p>
* 类似于枚举这样的类型,通常需要设置固定的码值表示对应的含义。
* 可实现 {@link IWithCode}、{@link IWithIntCode}、{@link IWithLongCode},便于在需要的地方对这些接口的实现进行处理。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/

View File

@@ -15,7 +15,7 @@
*/
/**
* <h2>集合<h2>
* <h2>集合</h2>
*
* <h3>
* 1. {@link CollectionTools}

View File

@@ -31,7 +31,7 @@ public final class PatternConsts {
* yyyyMMdd
*
* @see RegexConsts#BASIC_ISO_DATE
* </p>
*
*/
public static final Pattern BASIC_ISO_DATE = Pattern.compile(RegexConsts.BASIC_ISO_DATE);

View File

@@ -15,7 +15,7 @@
*/
/**
* <h2>常量<h2>
* <h2>常量</h2>
*
* <h3>
* 1. 正则常量

View File

@@ -24,13 +24,12 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
*
* <p>
* 异常在不同场景下被抛出,可以用不同的枚举值,表示不同的场景类型。
* </p>
*
* <p>
* 异常实现 {@link MultiTypesException} 的 {@link #getType} 方法,返回对应的场景类型。
* </p>
*
* <p>
* 表示场景类型的枚举实现 {@link ExceptionType},其中的工厂方法用于创建对应类型的异常。
* </p>
*
* <pre>
* public final class LoginException
@@ -61,7 +60,7 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
*
* // ...
*
* public enum Type implements ExceptionType<LoginException> {
* public enum Type implements ExceptionType&lt;LoginException&gt; {
* DEFAULT("00", "当前会话未登录"),
* NOT_TOKEN("10", "未提供token"),
* INVALID_TOKEN("20", "token无效"),
@@ -117,7 +116,6 @@ import xyz.zhouxy.plusone.commons.base.IWithCode;
* <pre>
* throw LoginException.Type.TOKEN_TIMEOUT.create();
* </pre>
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -33,7 +33,6 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException.ExceptionType;
* <pre>
* throw new RequestParamsException(ParsingFailureException.of(ParsingFailureException.Type.NUMBER_PARSING_FAILURE));
* </pre>
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -21,11 +21,10 @@ package xyz.zhouxy.plusone.commons.exception.business;
*
* <p>
* 业务异常
* </p>
*
* <p>
* <b>NOTE: 通常表示业务中的意外情况。如:用户错误输入、缺失必填字段、用户余额不足等。</b>
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0
*/

View File

@@ -26,11 +26,10 @@ import xyz.zhouxy.plusone.commons.exception.MultiTypesException;
*
* <p>
* 用户输入内容非法
* </p>
*
* <p>
* <b>NOTE: 属业务异常</b>
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0
*/

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.business;
*
* <p>
* 用户请求参数错误
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -15,18 +15,17 @@
*/
/**
* <h2>异常<h2>
* <h2>异常</h2>
*
* <h3>1. {@link MultiTypesException} - 多类型异常</h3>
* <p>
* 异常在不同场景下被抛出,可以用不同的枚举值,表示不同的场景类型。
* </p>
*
* <p>
* 异常实现 {@link MultiTypesException} 的 {@link MultiTypesException#getType} 方法,返回对应的场景类型。
* </p>
*
* <p>
* 表示场景类型的枚举实现 {@link MultiTypesException.ExceptionType},其中的工厂方法用于创建对应类型的异常。
* </p>
*
* <pre>
* public final class LoginException
@@ -57,7 +56,7 @@
*
* // ...
*
* public enum Type implements ExceptionType<LoginException> {
* public enum Type implements ExceptionType&lt;LoginException&gt; {
* DEFAULT("00", "当前会话未登录"),
* NOT_TOKEN("10", "未提供token"),
* INVALID_TOKEN("20", "token无效"),
@@ -113,7 +112,6 @@
* <pre>
* throw LoginException.Type.TOKEN_TIMEOUT.create();
* </pre>
* </p>
*
* <h3>2. 业务异常</h3>
* 预设常见的业务异常。可继承 {@link BizException} 自定义业务异常。

View File

@@ -21,13 +21,12 @@ package xyz.zhouxy.plusone.commons.exception.system;
*
* <p>
* 当数据操作的结果不符合预期时抛出。
* </p>
*
* <p>
* 比如当一个 insert 或 update 操作时,预计影响数据库中的一行数据,但结果却影响了零条数据或多条数据,
* 当出现这种始料未及的诡异情况时,抛出 {@link DataOperationResultException} 并回滚事务。
* 后续需要排查原因。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0
*/

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.system;
*
* <p>
* 在无法找到可访问的 Mac 地址时抛出
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.exception.system;
*
* <p>
* 通常表示应用代码存在问题,或因环境问题,引发异常。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -24,7 +24,6 @@ import com.google.common.annotations.Beta;
* <p>
* 一个特殊的 {@link java.util.function.UnaryOperator}。
* 表示对 {@code boolean} 值的一元操作。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -24,7 +24,6 @@ import com.google.common.annotations.Beta;
* <p>
* 一个特殊的 {@link java.util.function.UnaryOperator}。
* 表示对 {@code char} 的一元操作。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function;
*
* <p>
* 表示一个无入参无返回值的操作,可抛出异常。
* </p>
*
* @param <E> 可抛出的异常类型
*

View File

@@ -24,7 +24,6 @@ import java.util.function.Supplier;
*
* <p>
* 返回 {@code Optional&lt;T&gt;} 对象。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -23,7 +23,6 @@ import java.util.function.Predicate;
*
* <p>
* {@link Predicate} 相关操作。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function;
*
* <p>
* 允许抛出异常的消费操作。是一个特殊的 {@link java.util.function.Consumer}。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -20,7 +20,6 @@ package xyz.zhouxy.plusone.commons.function;
*
* <p>
* 接收一个参数,并返回一个结果,可以抛出异常。
* </p>
*
* @param <T> 入参类型
* @param <R> 返回结果类型

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function;
*
* <p>
* 接收一个参数,返回一个布尔值,可抛出异常。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -21,7 +21,6 @@ package xyz.zhouxy.plusone.commons.function;
*
* <p>
* 允许抛出异常的 Supplier 接口。
* </p>
*
* @param <T> 结果类型
* @param <E> 异常类型

View File

@@ -20,7 +20,6 @@
* <h3>1. PredicateTools</h3>
* <p>
* {@link PredicateTools} 用于 {@link java.util.function.Predicate} 的相关操作。
* </p>
*
* <h3>2. Functional interfaces</h3>
* <p>
@@ -39,7 +38,6 @@
* | Optional | ToOptionalBiFunction | Optional&lt;R&gt; apply(T,U) |
* | Optional | ToOptionalFunction | Optional&lt;R&gt; apply(T) |
* </pre>
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/

View File

@@ -164,7 +164,7 @@ public class JSR310TypeAdapters {
*
* <p>
* 使用 {@link DateTimeFormatter#ISO_INSTANT} 进行 {@link Instant} 的序列化与反序列化。
* </p>
*
*/
public static final class InstantTypeAdapter extends TypeAdapter<Instant> {

View File

@@ -40,7 +40,6 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
*
* <p>
* 中国第二代居民身份证号
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -37,7 +37,6 @@ import xyz.zhouxy.plusone.commons.util.StringTools;
* <p>
* 根据传入的 {@code size} 和 {@code pageNum}
* 提供 {@code getOffset} 方法计算 SQL 语句中 {@code offset} 的值。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @see PagingParams

View File

@@ -22,12 +22,12 @@
* 分页组件由 {@link PagingAndSortingQueryParams} 作为入参,
* 因为分页必须伴随着排序,不然可能出现同一个对象重复出现在不同页,有的对象不被查询到的情况,
* 所以分页查询的入参必须包含排序条件。
* </p>
*
* <p>
* 用户可继承 {@link PagingAndSortingQueryParams}
* 构建自己的分页查询入参,需在构造器中调用 {@link PagingAndSortingQueryParams} 的构造器,传入一个 Map 作为白名单,
* key 是供前端指定用于排序的属性名value 是对应数据库中的字段名,只有在白名单中指定的属性名才允许作为排序条件。
* </p>
*
* <p>
* {@link PagingAndSortingQueryParams} 包含三个主要的属性:
* <ul>
@@ -37,21 +37,20 @@
* </ul>
* 其中 orderBy 是一个 List可以指定多个排序条件每个排序条件是一个字符串
* 格式为“属性名-ASC”或“属性名-DESC”分别表示升序和降序。
* </p>
*
* <p>
* 比如前端传入的 orderBy 为 ["name-ASC","age-DESC"],意味着要按 name 进行升序name 相同的情况下则按 age 进行降序。
* </p>
*
* <p>
* 使用时调用 {@link PagingAndSortingQueryParams#buildPagingParams()} 方法获取分页参数 {@link PagingParams}。
* </p>
*
* <p>
* 分页结果可以存放到 {@link PageResult} 中,作为出参。
* </p>
*
* <h3>2. {@link UnifiedResponse}</h3>
* <p>
* {@link UnifiedResponse} 对返回给前端的数据进行封装,包含 code、message、data。
* </p>
*
* <p>
* 可使用 {@link UnifiedResponses} 快速构建 {@link UnifiedResponse} 对象。
* {@link UnifiedResponses} 默认的成功代码为 "2000000"
@@ -60,7 +59,6 @@
* 中所示范的,继承 {@link UnifiedResponses} 实现自己的工厂类,
* 自定义 SUCCESS_CODE 和 DEFAULT_SUCCESS_MSG 和工厂方法。
* 见 <a href="http://zhouxy.xyz:3000/plusone/plusone-commons/issues/22">issue#22</a>。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/

View File

@@ -18,7 +18,6 @@
* <h2>业务建模组件</h2>
* <p>
* 包含业务建模可能用到的性别、身份证等元素,也包含 DTO 相关类,如分页查询参数,响应结果,分页结果等。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/

View File

@@ -15,7 +15,7 @@
*/
/**
* <h2>时间 API<h2>
* <h2>时间 API</h2>
*
* <h3>1. 季度 API</h3>
*

View File

@@ -33,7 +33,6 @@ import javax.annotation.Nullable;
*
* <p>
* 数组工具类
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -29,7 +29,6 @@ import xyz.zhouxy.plusone.commons.exception.system.DataOperationResultException;
*
* <p>
* 本工具类不封装过多判断逻辑,鼓励充分使用项目中的工具类进行逻辑判断。
* </p>
*
* <pre>
* AssertTools.checkArgument(StringUtils.hasText(str), "The argument cannot be blank.");

View File

@@ -28,7 +28,6 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
*
* <p>
* BigDecimal 工具类
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -215,7 +215,6 @@ public class DateTimeTools {
* <p>
* 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上还是同一时间戳,
* 只是不同时区的表示。
* </p>
*
* @param timeMillis 时间戳
* @param zone 时区
@@ -230,7 +229,6 @@ public class DateTimeTools {
* <p>
* 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上还是同一时间戳,
* 只是不同时区的表示。
* </p>
*
* @param dateTime {@link Date} 对象
* @param zone 时区
@@ -245,7 +243,6 @@ public class DateTimeTools {
* <p>
* 传入不同 {@link ZoneId},获取到的 {@link ZonedDateTime} 对象实际上表示的还是还是同一时间戳的时间,
* 只是不同时区的表示。
* </p>
*
* @param dateTime {@link Date} 对象
* @param timeZone 时区

View File

@@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.annotation.StaticFactoryMethod;
* 参考 <a href="https://lostechies.com/jimmybogard/2008/08/12/enumeration-classes/">Enumeration classes</a>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C# 的枚举不带行为。
* @deprecated 设计 Enumeration 的灵感来自于 .net 社区,因为 C&num; 的枚举不带行为。
* 但 Java 的枚举可以带行为,故大多数情况下不需要这种设计。
*/
@Deprecated

View File

@@ -26,7 +26,6 @@ import java.util.concurrent.ConcurrentHashMap;
*
* <p>
* 生成 UUID 和 修改版雪花IDSeata 版本)
* </p>
*
* @see UUID
* @see IdWorker

View File

@@ -34,7 +34,7 @@ import xyz.zhouxy.plusone.commons.exception.system.NoAvailableMacFoundException;
* <li>每个机器线程安全地生成序列前面加上机器的id这样就不会与其它机器的id相冲突。</li>
* <li>时间戳作为序列的“预留位”,它更像是应用启动时最开始的序列的一部分,在一个时间戳里生成 4096 个 id 之后,直接生成下一个时间戳的 id。</li>
* </ol>
* </p>
*
* <p>
* 详情见以下介绍:
* <ul>
@@ -43,7 +43,7 @@ import xyz.zhouxy.plusone.commons.exception.system.NoAvailableMacFoundException;
* <li><a href="https://juejin.cn/post/7264387737276203065">在开源项目中看到一个改良版的雪花算法,现在它是你的了。</a></li>
* <li><a href="https://juejin.cn/post/7265516484029743138">关于若干读者,阅读“改良版雪花算法”后提出的几个共性问题的回复。</a></li>
* </ul>
* </p>
*
*/
public class IdWorker {

View File

@@ -45,7 +45,6 @@ public class OptionalTools {
* <p>
* 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalInt} 后,由
* {@link OptionalInt#empty()} 表示值的缺失。
* </p>
*
* @param value 包装对象
* @return {@link OptionalInt} 实例
@@ -58,7 +57,6 @@ public class OptionalTools {
* 将 {@code Optional<Integer>} 对象转为 {@link OptionalInt} 对象。
* <p>
* {@code Optional<Integer>} 将整数包装了两次,改为使用 {@link OptionalInt} 包装其中的整数数据。
* </p>
*
* @param optionalObj {@code Optional<Integer>} 对象
* @return {@link OptionalInt} 实例
@@ -72,7 +70,6 @@ public class OptionalTools {
* <p>
* 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalLong} 后,由
* {@link OptionalLong#empty()} 表示值的缺失。
* </p>
*
* @param value 包装对象
* @return {@link OptionalLong} 实例
@@ -85,7 +82,6 @@ public class OptionalTools {
* 将 {@code Optional<Long>} 转为 {@link OptionalLong}。
* <p>
* {@code Optional<Long>} 将整数包装了两次,改为使用 {@link OptionalLong} 包装其中的整数数据。
* </p>
*
* @param optionalObj 包装对象
* @return {@link OptionalLong} 实例
@@ -99,7 +95,6 @@ public class OptionalTools {
* <p>
* 包装类为 {@code null} 表示值的缺失,转为 {@link OptionalDouble} 后,由
* {@link OptionalDouble#empty()} 表示值的缺失。
* </p>
*
* @param value 包装对象
* @return {@link OptionalDouble} 实例
@@ -112,7 +107,6 @@ public class OptionalTools {
* 将 {@code Optional<Double>} 转为 {@link OptionalDouble}。
* <p>
* {@code Optional<Double>} 将整数包装了两次,改为使用 {@link OptionalDouble} 包装其中的整数数据。
* </p>
*
* @param optionalObj 包装对象
* @return {@link OptionalDouble} 实例

View File

@@ -26,7 +26,7 @@ import java.util.concurrent.ThreadLocalRandom;
* 随机工具类
* <p>
* 建议调用方自行维护 Random 对象
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/
public final class RandomTools {

View File

@@ -31,7 +31,6 @@ import xyz.zhouxy.plusone.commons.constant.PatternConsts;
*
* <p>
* 字符串工具类。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
* @since 1.0.0

View File

@@ -18,7 +18,6 @@
* <h2>工具类</h2>
* <p>
* 包含树构建器({@link TreeBuilder})、断言工具({@link AssertTools}、ID 生成器({@link IdGenerator})及其它实用工具类。
* </p>
*
* @author <a href="http://zhouxy.xyz:3000/ZhouXY108">ZhouXY</a>
*/