注释文档的优化

This commit is contained in:
lqyan
2024-02-20 13:26:28 +08:00
parent 162ef3771e
commit f6272514d8
32 changed files with 1947 additions and 8 deletions

View File

@@ -5,11 +5,12 @@ import lombok.Getter;
/**
* 这个异常标识传入的SDK方法的参数错误
* <p>
* 通常情况下{@link ClientException开发者额外处理它因为它通常出现在开发的时候
* 通常情况下{@link ArgsException开发者额外处理它因为它通常出现在开发的时候
* <p>
* 例如: 调用重命名文件的接口,要求源文件路径和新的文件名是必填的参数,
* 如果开发者在调用的过程中没填装个参数,则程序会抛出 {@link ClientException
* 如果开发者在调用的过程中没填装个参数,则程序会抛出 {@link ArgsException
* <p>
*
* @author yanlongqi
* @date 2024/1/31 10:36
*/

View File

@@ -4,9 +4,9 @@ import lombok.Getter;
/**
* <p>这个异常是客户端访问景行API时抛出的异常。
* <p>{@link RuntimeException表示景行API客户端任何异常的类。
* 一般情况下,{@link RuntimeException要么发生在发送请求之前要么发生在收到OSS服务器端的响应之后。
* 例如如果在尝试发送请求时网络断开则SDK将抛出{@link RuntimeException实例。
* <p>{@link ClientException表示景行API客户端任何异常的类。
* 一般情况下,{@link ClientException要么发生在发送请求之前要么发生在收到景行API服务器端的响应之后。
* 例如如果在尝试发送请求时网络断开则SDK将抛出{@link ClientException实例。
* <p>{@link ServiceException是从景行API响应的错误代码转换而来的。
* 例如当请求的接口参数错误时SDK会抛出一个@link ServiceException或其子类实例。
* 并带有特定的错误代码,调用者可以用特定的逻辑来处理.