定制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。这可以被其他开发人员用来获取使用提示。

Answer 2

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

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

Answer 3

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