java - 自定义 Java 代码库使用技巧

Question

我正在开发一个用于某些特定验证操作的库。一切对我来说使用起来都还可以，但是当我发布它时，每次开发人员都需要阅读手册文档。

所以，我想展示下图所示的使用技巧。

我该怎么做？

Answer 1

您需要在代码中编写JavaDoc 注释，然后才能生成JavaDoc html。

JavaDoc注释是介于/**和*/之间的特殊注释，可用于生成JavaDoc。例如

/**
 * Class description.
 * <p>
 * Some more details
 * 
 * @author Edd
 */
public class MyClass {

    /**
     * Method description.
     * 
     * @param param
     *            important parameter
     */
    public static void myMethod(String param) {

    }
}

工具提示看起来像这样:

当您发布您的库供其他开发人员使用时，您通常会将其作为 jar 文件发布。当你打包你的 jar 时，你还应该生成一个 javadoc.jar 文件来伴随你的 jar。然后其他开发人员可以使用它来获取使用提示。