Пользовательские советы по использованию библиотеки Java Code

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) { 

    } 
} 

Это будет выглядеть так, как подсказка:

Когда вы отпускаете вашу библиотеку для других разработчиков использовать, вы, как правило, выпустить его в виде файла банку. Когда вы упаковываете свою банку, вы также должны генерировать файл javadoc.jar, чтобы сопровождать вашу банку. Это может быть использовано другими разработчиками для получения советов по использованию.

Answer 2

Написать комментарий JavaDoc и опубликовать их вместе с вашей библиотекой.

Если вы используете Maven, вы можете использовать javadoc:jar goalMaven Javadoc Plugin.

Answer 3

Подробнее об использовании и использовании javadoc, здесь: http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html