I am developing a library which is used for some specific validation operations. Every thing is ok for me in usage, but when I publish it, every time developers need to read manual document.
So, I want to show usage tips like shown blow.
How can i do it ?
You need to write JavaDoc comments in your code and then you can generate JavaDoc html.
JavaDoc comments are special comments which are between /** and */ and can be used to generate 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) {
}
}
This would then look like this as a tooltip:
When you release your library for other developers to use, you would typically release it as a jar file. When you package up your jar you should also generate a javadoc.jar file to accompany your jar. This can then be used by other developers to get the usage tips.
Write JavaDoc comments and publish them together with your library.
If you are using Maven, you can use the javadoc:jar goal of the Maven Javadoc Plugin.
Read about and use javadoc, here: http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html
