Sharpen 技术文档

以下为 Sharpen 项目的详细技术文档，帮助用户更好地了解、安装和使用该自动化 Java 到 C# 代码转换工具。

1. 安装指南

在开始使用 Sharpen 之前，请确保完成以下步骤：

1. 克隆项目仓库。
2. 安装 Java 7 和 Maven。请注意，Java 6、8 及更高版本不受支持。
3. 在项目根目录下运行 mvn clean test 进行测试。
4. 运行 mvn install 生成 .jar 文件至 /sharpen.core/target 目录。

2. 项目使用说明

安装完成后，您可以通过以下方式运行 Sharpen：

1. mvn install 命令执行完毕后，会生成一个名为 sharpencore-0.0.1-SNAPSHOT-jar-with-dependencies.jar 的文件。这是一个自包含的 Sharpen 版本，可以在任何地方运行。

2. 使用以下命令运行 Sharpen：

   java -jar sharpencore-0.0.1-SNAPSHOT-jar-with-dependencies.jar SOURCEPATH -cp JAR_DEPENDENCY_A JAR_DEPENDENCY_B
   

   其中 JAR_DEPENDENCY_A 和 JAR_DEPENDENCY_B 为 Java 源代码所需依赖的完整路径，SOURCEPATH 也应为完整路径。

3. 运行 -help 获取命令行语法帮助。

3. 项目 API 使用文档

Sharpen 提供了代码配置类，以便用户可以自定义代码转换选项和行为。以下为如何创建和使用自定义配置类的方法：

创建外部配置类

您的自定义配置类需满足以下条件：

• 继承 Configuration 类（位于 sharpen.core/src/sharpen/core/Configuration.java）。
• 必须为公开可见。
• 必须有一个公开的构造函数。

一个示例配置项目可以在以下地址找到：sharpen_imazen_config。

使用自定义配置类

将您的配置类打包为一个名为 <配置类名称>.sharpenconfig.jar 的 JAR 文件，并将其放在 Sharpen 目录下。然后通过命令行参数 -configurationClass（或在选项文件中）指定完整的配置类名称。

例如，对于使用 XMP core port 和预构建的 Sharpen 配置 的情况，可以这样使用：

java -jar sharpen-jar-with-dependencies.jar C:/java_src/ -configurationClass sharpen.config.MEConfiguration @sharpen-all-options-without-configuration

配置也可以在选项文件中指定。在这种情况下，使用方法如下：

java -jar sharpen-jar-with-dependencies.jar C:/java_src/ @sharpen-all-options

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细描述，请参考上述步骤进行安装。