mcj:编写注释

src/main/java/com/zjty/inspect/entity/Budget.java

@@ -17,8 +17,11 @@ import java.sql.Timestamp;
 
 @Data
 public class Budget {
+
     /**
-     * 代码重构预算、代码修改预算、
+     * 名称
+     * 代码重构预算
+     * 代码修改预算、
      */
     private String budgetName;
     /**

src/main/java/com/zjty/inspect/entity/DepTreeVo.java → src/main/java/com/zjty/inspect/entity/DependencyVo.java

@@ -12,7 +12,7 @@ import java.util.List;
  * @date 2020-02-21 20:26
  */
 @Data
-public class DepTreeVo implements Serializable {
+public class DependencyVo implements Serializable {
     private List<ProjectPom> depTreeList = new ArrayList<>();
     private List<ProjectPom> frontend = new ArrayList<>();
 

src/main/java/com/zjty/inspect/entity/Pages.java

-package com.zjty.inspect.entity;
-
-import lombok.Data;
-
-/**
- * @author Mcj
- * @date 2020-03-03 11:56
- */
-@Data
-public class Pages {
-    private int page;
-    private String id;
-}

src/main/java/com/zjty/inspect/entity/PomAnalysis.java

@@ -23,25 +23,5 @@ public class PomAnalysis {
     private String name;
     private String url;
     private String description;
-    //private List<Prerequisite> prerequisites;//描述了这个项目构建环境中的前提条件。 -->
-    //private IssueManagement issueManagement;//项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL
-    //private CiManagement ciManagement;//项目持续集成信息
-    //private String inceptionYear;//项目创建年份，4位数字。当产生版权信息时需要使用这个值
-    //private MailingLists mailingLists;//项目相关邮件列表信息
-    //private Developers developers;//项目开发者列表
-    //private Contributors contributors;//项目的其他贡献者列表
-    //private List<License> licenses;//该元素描述了项目所有License列表。 应该只列出该项目的license列表，不要列出依赖项目的 license列表。如果列出多个license，用户可以选择它们中的一个而不是接受所有license
-    //private Scm scm;//SCM(Source Control Management)标签允许你配置你的代码库，供Maven web站点和其它插件使用
-    //private Organization organization;//描述项目所属组织的各种属性。Maven产生的文档用
-    //private Build build;//构建项目需要的信息
-    //private List<Profile> profiles;//在列的项目构建profile，如果被激活，会修改构建处理
-    //private List<Module> modules;//模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径
-    //private List<Repository> repositories;//发现依赖和扩展的远程仓库列表
-    //private List<PluginRepository> pluginRepositiries;//发现插件的远程仓库列表，这些插件用于构建和报表
     private List<PomDependency> dependencies;
-    //private Repoting repoting;//该元素描述使用报表插件产生报表的规范。当用户执行“mvn site”，这些报表就会运行。 在页面导航栏能看到所有报表的链接
-    //private DependencyManagement dependencyManagement;//继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖（必须描述group ID和artifact ID信息），如果group ID和artifact ID以外的一些信息没有描述，则通过group ID和artifact ID匹配到这里的依赖，并使用这里的依赖信息
-    //private DistributionManagement distributionManagement;//项目分发信息，在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库
-    //private Properties properties;//以值替代名称，Properties可以在整个POM中使用，也可以作为触发条件（见settings.xml配置文件里activation元素的说明）。格式是<name>value</name>
-
 }

src/main/java/com/zjty/inspect/entity/Properties.java

-package com.zjty.inspect.entity;
-
-import lombok.Data;
-
-/**
- * @author Mcj
- * @date 2020-02-17 16:11
- */
-@Data
-public class Properties {
-    private String name;
-    private String value;
-}

src/main/java/com/zjty/inspect/entity/ReportVo.java

@@ -3,7 +3,6 @@ package com.zjty.inspect.entity;
 import lombok.Data;
 
 import javax.persistence.Column;
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 
@@ -59,7 +58,7 @@ public class ReportVo {
     /**
      * 依赖
      */
-    private DepTreeVo depTreeVo;
+    private DependencyVo dependencyVo;
 
     /**
      * 匹配技术列表

src/main/java/com/zjty/inspect/entity/Warn.java

@@ -29,6 +29,11 @@ public class Warn {
      */
     private String technologyId;
 
+    /**
+     * 适配技术名称
+     */
+    private String technologyName;
+
     /**
      * 关键字id
      */

src/main/java/com/zjty/inspect/enums/DependenceManagement.java

+package com.zjty.inspect.enums;
+
+
+
+/**
+ * @author mcj
+ */
+
+public enum DependenceManagement {
+
+    /**
+     * maven方式
+     */
+    MAVEN,
+    /**
+     * gradle方式
+     */
+    GRADLE,
+
+}

src/main/java/com/zjty/inspect/enums/Language.java

+package com.zjty.inspect.enums;
+
+/**
+ *
+ *
+ * @author mcj
+ */
+public enum Language {
+    /**
+     * java类型
+     */
+    JAVA,
+    /**
+     * pyth类型
+     */
+    PYTHON,
+
+    /**
+     * asp
+     */
+    ASP,
+    /**
+     * js
+     */
+    JAVASCRIPT,
+    /**
+     * go
+     */
+    GO,
+
+    /**
+     * html
+     */
+    HTML,
+    UNKNOW,
+
+}

src/main/java/com/zjty/inspect/service/impl/InspectServiceImpl.java

@@ -32,12 +32,15 @@ public class InspectServiceImpl implements InspectService {
         suffixLanguageMapping.put("vue", Report.Language.VUE);
         suffixLanguageMapping.put("cpp", Report.Language.CPP);
         suffixLanguageMapping.put("py", Report.Language.PYTHON);
-        suffixLanguageMapping.put("jsp", Report.Language.JSP);
+        suffixLanguageMapping.put("jsp", Report.Language.JAVA);
         suffixLanguageMapping.put("go", Report.Language.GO);
         suffixLanguageMapping.put("js", Report.Language.JAVASCRIPT);
         suffixLanguageMapping.put("html", Report.Language.HTML);
+        //构造成员变量
         inspector.setInspectParameter(inspectParameter);
+        //构造报告vo
         inspector.setReport(reportVo);
+        //需要重构
         inspector.setSuffixLanguageMapping(suffixLanguageMapping);
         ReportVo report = inspector.inspect();
         return report;