jdt-codemining 项目安装与使用教程

jdt-codemining 项目安装与使用教程

1. 项目的目录结构及介绍

jdt-codemining/
├── images/
│   ├── org.eclipse.egit.codemining/
│   └── org.eclipse.jdt.codemining.tests/
├── org.eclipse.egit.codemining/
├── org.eclipse.jdt.codemining.tests/
├── org.eclipse.jdt.codemining/
├── update-site/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── pom.xml
└── pushToBintray.sh

目录结构介绍

• images/: 包含项目相关的图片资源。
  • org.eclipse.egit.codemining/: EGit 代码挖掘相关的图片资源。
  • org.eclipse.jdt.codemining.tests/: JDT 代码挖掘测试相关的图片资源。
• org.eclipse.egit.codemining/: EGit 代码挖掘插件的源代码。
• org.eclipse.jdt.codemining.tests/: JDT 代码挖掘插件的测试代码。
• org.eclipse.jdt.codemining/: JDT 代码挖掘插件的源代码。
• update-site/: 更新站点文件，用于插件的安装和更新。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• pom.xml: Maven 项目配置文件。
• pushToBintray.sh: 用于将项目推送到 Bintray 的脚本。

2. 项目的启动文件介绍

项目的启动文件主要位于 org.eclipse.jdt.codemining/ 目录下，具体文件包括但不限于：

• Activator.java: 插件的激活类，负责插件的初始化和启动。
• CodeMiningProvider.java: 代码挖掘提供者类，负责定义和注册代码挖掘功能。
• CodeMining.java: 代码挖掘类，定义了代码挖掘的具体实现。

这些文件共同协作，确保插件在 Eclipse 中正确启动并提供代码挖掘功能。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个部分：

• pom.xml: Maven 项目配置文件，定义了项目的依赖、构建配置等。
• plugin.xml: 插件配置文件，定义了插件的扩展点和扩展。
• preferences.ini: 插件的偏好设置文件，定义了插件的默认配置选项。

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.eclipse.jdt.codemining</groupId>
    <artifactId>jdt-codemining</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <!-- 依赖配置 -->
    </dependencies>
    <build>
        <!-- 构建配置 -->
    </build>
</project>

plugin.xml

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
   <extension point="org.eclipse.jdt.ui.javaCodeMinings">
      <codeMiningProvider class="org.eclipse.jdt.codemining.CodeMiningProvider"/>
   </extension>
</plugin>

preferences.ini

org.eclipse.jdt.codemining.showVariableValues=true
org.eclipse.jdt.codemining.showMethodParameterNames=true
org.eclipse.jdt.codemining.showMethodParameterTypes=true

这些配置文件共同确保了插件的正确安装、启动和功能配置。