Чтобы не было скучно и чтобы, как я уже говорил, показать работу и пользу от документирующих комментариев (javadoc), я немного модифицировал нашу программу и она вышла на следующую ступень эволюции. И так встречайте! Advanced Hello World!
А это то, что она выводит на консоль Eclipse при запуске.
Хотя оператора вывода три, нам вывелось две строки. Читаем комментарии чтобы понять.
Обратите внимание что наш длинный метод System.out.print теперь сильно укоротился 
Так же следует обратить внимание на последний метод printf. В нем за словом World нет восклицательного знака (!). Этот метод пришел в Java из C. Но это так для справки.
Использование таких коротких методов, верней их вызовов стало возможным благодаря статическому импорту этих методов из библиотеки ProJava.jar, которую я быстренько написал, дабы было проще выводить на консоль сообщения. Этот импорт делается в первой строке программы.
Про статический импорт, библиотеки и т.д. и т.п. мы поговорим значительно позже, когда уже перейдем к объектно-ориентированному программированию.
Пока этот пример нужен, чтобы в дальнейшем разобраться с документирующими комментариями, classpath, а так же компиляцией в ручную данного проекта, поскольку хорошо понимать и знать что происходит под капотом IDE, когда она компилирует и собирает проект.
Теперь, для справки, приведу и текст самой библиотеки:
Тут пока особо объяснять ни чего не буду, все что нужно сейчас это обратить внимание на комментарии, чтобы немного понять что происходит, а так же начать разбираться с javadoc.
Javadoc – это очень удобная и полезная штука. Она позволяет создавать напоминалки объяснение справку для чего нужен тот или иной класс, его методы, поля и т.д. и т.п.
Это очень полезно, если вы создаете какую-то свою библиотеку. Так как обычно уже через полгода с трудом вспоминаешь, что же ты там написал и как это работает. А javadoc может на лету подсказать как использовать тот или иной метод.
Вот простой пример работы javadoc
Наводишь курсор на метод и получаешь краткую справку, в которую потом можно перейти по F2
Не правда ли очень удобная штука?
А теперь посмотрим что произойдет если навести курсор на println в программе AdvancedHello.java
Нам сообщили что нетути Javadoc для этого метода. Будем это исправлять в следующей серии.
Комментариев нет:
Отправить комментарий