自定义Java代码库使用技巧

Question

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

所以，我想展示一下使用技巧，比如吹嘘。

我该怎么办？

Answer 1

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

JavaDoc注释是/**和*/之间的特殊注释，可用于生成JavaDoc。 e.g。

/**
 * 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。然后，其他开发人员可以使用它来获取使用提示。

Answer 2

编写JavaDoc注释并与库一起发布。

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

Answer 3

阅读并使用javadoc，在这里：http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html