КаталогИндекс раздела
НазадОглавлениеВперед


Работа 11: Генерация Javadoc в Eclipse

Цель работы:

Цель этой работы - познакомить вас с документированием вашего Java-кода при помощи комментариев Javadoc и тегов и с использованием инструмента Javadoc в Eclipse для выработки Javadoc-выхода в стандартном доклете.

Выполнение работы:

Шаг 1: Полное комментирование вашего класса Game

Возьмите ваш класс Game и полностью прокомментируйте его.

  1. Обеспечьте комментарий перед классом, который будет также включать в себя автора, версию и теги see.
  2. Прокомментируйте начало каждого метода. Убедитесь, что параметры и возвращаемое значение определены при помощи тегов param и return.
  3. Если нужно, добавьте тег see и соответствующий класс в комментарии вашего метода.
Полезно включать теги HTML в ваш текст javadoc. Например, следующее является комментарием с тегами (<p>, <tt></tt>, <i></i>), которые вы тоже можете встраивать в ваши документы. Попробуйте вывести это и посмотрите, что они будут делать.
 * <p>Many different types of exceptions can happen. For example
 * throw <tt>LifeGameException</tt> might be thrown. 
 * It is wrong to write a program that depended on an
 * exception for its correctness:  <i>the fail-fast behavior 
 * should not be used</i> 

Шаг 2: Экспорт Javadoc

Экспортируйте ваш пакет Игры жизни как Javadoc. Выберите только ваш пакет для создания Javadoc, в Мастере генерации Javadoc. Не забудьте установить опции и целевой каталог. Если все пройдет хорошо, вы увидите что-то вроде следующего в окне консоли. Если вы увидите комментарий, окрашенный КРАСНЫМ, у вас есть проблемы. Прочитайте комментарии и исправьте их.


Loading source files for package org.eclipse.lifegame.test...
Loading source files for package org.eclipse.lifegame.support...
Loading source files for package org.eclipse.lifegame.domain...
Constructing Javadoc information...
Standard Doclet version 1.4.1

Generating C:\eclipse\workspace\LifeGame\doc\constant-values.html...
Building tree for all the packages and classes...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\class-use\LifeGameTester.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\class-use\LifeGameException.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalSurvivalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalGame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalDeathRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalBoard.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\TwoDimensionalBirthRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\SurvivalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\Rule.html... 
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\Game.java:48: warning - @return tag has no arguments.
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\Game.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\DeathRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\Board.html... 
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\Game.java:34: warning - @return tag has no arguments.
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\class-use\BirthRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\package-use.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\package-use.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\package-use.html...
Building index for all the packages and classes...
Generating C:\eclipse\workspace\LifeGame\doc\overview-tree.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-1.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-2.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-3.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-4.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-5.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-6.html... 
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\Game.java:90: warning - @return tag has no arguments.
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\TwoDimensionalBoard.java:22: warning - @return tag has no arguments.
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\Game.java:76: warning - @return tag has no arguments.
C:\eclipse\workspace\LifeGame\org\eclipse\lifegame\domain\Rule.java:19: warning - @return tag has no arguments. 
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-7.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-8.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-9.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-10.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-11.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-12.html...
Generating C:\eclipse\workspace\LifeGame\doc\index-files\index-13.html...
Generating C:\eclipse\workspace\LifeGame\doc\deprecated-list.html...
Building index for all classes...
Generating C:\eclipse\workspace\LifeGame\doc\allclasses-frame.html...
Generating C:\eclipse\workspace\LifeGame\doc\allclasses-noframe.html...
Generating C:\eclipse\workspace\LifeGame\doc\index.html...
Generating C:\eclipse\workspace\LifeGame\doc\packages.html...
Generating C:\eclipse\workspace\LifeGame\doc\overview-summary.html...
Generating C:\eclipse\workspace\LifeGame\doc\overview-frame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\package-frame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\package-summary.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\package-tree.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\package-frame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\package-summary.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\package-tree.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\package-frame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\package-summary.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\package-tree.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\test\LifeGameTester.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\support\LifeGameException.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\BirthRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\Board.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\DeathRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\Game.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\Rule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\SurvivalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalBirthRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalBoard.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalDeathRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalGame.html...
Generating C:\eclipse\workspace\LifeGame\doc\org\eclipse\lifegame\domain\TwoDimensionalSurvivalRule.html...
Generating C:\eclipse\workspace\LifeGame\doc\serialized-form.html...
Generating C:\eclipse\workspace\LifeGame\doc\package-list...
Generating C:\eclipse\workspace\LifeGame\doc\help-doc.html...
Generating C:\eclipse\workspace\LifeGame\doc\stylesheet.css...
6 warnings

Посмотрите теперь в целевой каталог, который вы определили для Javadoc. Вы должны увидеть результирующие файлы HTML. Если вы выберете выходной каталог по умолчанию, он будет создан в корне проекта в рабочем пространстве и также будет показан в Eclipse Workbench.

Двойной щелчок на файле index.html покажет Javadoc следующим образом:


НазадОглавлениеВперед
КаталогИндекс раздела