2

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

所以，我想展示一些使用技巧，比如所示的打击。

在此处输入图像描述

我该怎么做 ？

4

3 回答 3

3

您需要在代码中编写 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) {

    }
}

这看起来像一个工具提示：

JavaDoc 工具提示

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

于 2013-07-05T13:42:15.487 回答
1

编写 JavaDoc 注释并将它们与您的库一起发布。

如果您使用的是 Maven，则可以使用Maven Javadoc Plugin的javadoc:jar目标。

于 2013-07-05T13:42:34.513 回答
1

在此处阅读和使用 javadoc： http ://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html

于 2013-07-05T13:42:35.613 回答