[文档修改](master): 修改完善了文档及注释

修改README.md 修改回传参数注释
3 years ago · 8e40e91e3a
parent 7f4a5f567d
commit 8e40e91e3a
2 changed files with 4 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -18,7 +18,9 @@

 #### 模块说明

-
+    short-server-common - 公共模块
+    short-server-pojo - dto/bo 用于模块之间的传输实体/领域模型定义
+    short-server-service - 短链生成服务
 #### 调用方式及API


--- a/short-server-service/src/main/java/com/by/api/vo/ShortChainResponseVO.java
+++ b/short-server-service/src/main/java/com/by/api/vo/ShortChainResponseVO.java
@ -13,7 +13,7 @@ import java.util.List;
 public class ShortChainResponseVO {

    /**
-     * 短链生成结果
+     * 短链生成结果 短链|号码标识
     */
    private List<String> shortChainResult;
 }