如何在 Maven 项目中包含用于 CPLEX API 的 JavaDoc？答案

【问题标题】：How to inlclude JavaDoc for CPLEX API in a maven project?如何在 Maven 项目中包含用于 CPLEX API 的 JavaDoc？
【发布时间】：2016-06-29 02:11:04
【问题描述】：

如何在我的 maven 项目中包含 Cplex JavaDoc 以获取 Cplex Java API 上的代码助手？

【问题讨论】：

你在某处有 cplex.jar 的 javaDoc 吗？还是你问怎么弄？
感谢您的快速评论。我想记录我刚刚为其他 CPLEX 用户找到的工作流。下面我自己的回答澄清了这个问题。

标签： maven javadoc cplex

【解决方案1】：

javadoc 可以在这里找到：

{PATH_TO_CPLEX_INSTALLATION_FOLDER}/doc/html/en-US/refjavacplex/html/

对于非 Maven 项目，您可以直接在项目设置中引用该路径。

对于 maven 项目，您可以将这些文件放入 javadoc jar 文件中：打开命令行并导航到文件夹，例如

cd C:/Program%20Files/IBM/ILOG/CPLEX_Enterprise_Server126/CPLEX_Studio/doc/html/en-US/refjavacplex/html/

然后创建javadoc jar文件：

jar cvf cplex-1263-javadoc.jar *

然后将创建的 javadoc jar 放在本地 maven 存储库中的 CPLEX 库 jar 和相应的 pom 文件旁边，例如

{PROJECT_ROOT}\maven_project_repository\ilog\cplex\1263\

cplex-1263.jar
cplex-1263-javadoc.jar
pom.xml

pom文件例如

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <modelVersion>4.0.0</modelVersion>
  <groupId>ilog.concert</groupId>
  <artifactId>cplex</artifactId>
  <version>1263</version>
</project>

在更新 Maven 依赖项时，javadoc 会与 API 一起自动检索。如果您使用 Eclipse，请在您的 Maven 设置中设置下载 javadoc 文件的复选框：

以下是一些用于包含本地 maven 存储库和 CPLEX 依赖项的 sn-ps：

<repositories>

        <!-- Custom In-Project repository that contains dependencies that can not 
            be found on maven servers -->
        <repository>
            <id>maven_project_repository</id>
            <name>Maven Project Repository Share</name>
            <url>file://${project.basedir}/maven_project_repository</url>
        </repository>
</repositories>

<dependencies>
<!-- cplex -->
        <dependency> <!-- from in project maven repository -->
            <groupId>ilog.concert</groupId>
            <artifactId>cplex</artifactId>
            <version>1263</version>
            <scope>compile</scope>
        </dependency>
</dependencies>

【讨论】：

IBM developerWorks 论坛上的 thread 确认了此答案。