Javadoc
Поделись знанием:
К:Википедия:Статьи без изображений (тип: не указан)
29 го мая Наполеон выехал из Дрездена, где он пробыл три недели, окруженный двором, составленным из принцев, герцогов, королей и даже одного императора. Наполеон перед отъездом обласкал принцев, королей и императора, которые того заслуживали, побранил королей и принцев, которыми он был не вполне доволен, одарил своими собственными, то есть взятыми у других королей, жемчугами и бриллиантами императрицу австрийскую и, нежно обняв императрицу Марию Луизу, как говорит его историк, оставил ее огорченною разлукой, которую она – эта Мария Луиза, считавшаяся его супругой, несмотря на то, что в Париже оставалась другая супруга, – казалось, не в силах была перенести. Несмотря на то, что дипломаты еще твердо верили в возможность мира и усердно работали с этой целью, несмотря на то, что император Наполеон сам писал письмо императору Александру, называя его Monsieur mon frere [Государь брат мой] и искренно уверяя, что он не желает войны и что всегда будет любить и уважать его, – он ехал к армии и отдавал на каждой станции новые приказания, имевшие целью торопить движение армии от запада к востоку. Он ехал в дорожной карете, запряженной шестериком, окруженный пажами, адъютантами и конвоем, по тракту на Позен, Торн, Данциг и Кенигсберг. В каждом из этих городов тысячи людей с трепетом и восторгом встречали его.
Армия подвигалась с запада на восток, и переменные шестерни несли его туда же. 10 го июня он догнал армию и ночевал в Вильковисском лесу, в приготовленной для него квартире, в имении польского графа.
На другой день Наполеон, обогнав армию, в коляске подъехал к Неману и, с тем чтобы осмотреть местность переправы, переоделся в польский мундир и выехал на берег.
Увидав на той стороне казаков (les Cosaques) и расстилавшиеся степи (les Steppes), в середине которых была Moscou la ville sainte, [Москва, священный город,] столица того, подобного Скифскому, государства, куда ходил Александр Македонский, – Наполеон, неожиданно для всех и противно как стратегическим, так и дипломатическим соображениям, приказал наступление, и на другой день войска его стали переходить Неман.
12 го числа рано утром он вышел из палатки, раскинутой в этот день на крутом левом берегу Немана, и смотрел в зрительную трубу на выплывающие из Вильковисского леса потоки своих войск, разливающихся по трем мостам, наведенным на Немане. Войска знали о присутствии императора, искали его глазами, и, когда находили на горе перед палаткой отделившуюся от свиты фигуру в сюртуке и шляпе, они кидали вверх шапки, кричали: «Vive l'Empereur! [Да здравствует император!] – и одни за другими, не истощаясь, вытекали, всё вытекали из огромного, скрывавшего их доселе леса и, расстрояясь, по трем мостам переходили на ту сторону.
– On fera du chemin cette fois ci. Oh! quand il s'en mele lui meme ca chauffe… Nom de Dieu… Le voila!.. Vive l'Empereur! Les voila donc les Steppes de l'Asie! Vilain pays tout de meme. Au revoir, Beauche; je te reserve le plus beau palais de Moscou. Au revoir! Bonne chance… L'as tu vu, l'Empereur? Vive l'Empereur!.. preur! Si on me fait gouverneur aux Indes, Gerard, je te fais ministre du Cachemire, c'est arrete. Vive l'Empereur! Vive! vive! vive! Les gredins de Cosaques, comme ils filent. Vive l'Empereur! Le voila! Le vois tu? Je l'ai vu deux fois comme jete vois. Le petit caporal… Je l'ai vu donner la croix a l'un des vieux… Vive l'Empereur!.. [Теперь походим! О! как он сам возьмется, дело закипит. Ей богу… Вот он… Ура, император! Так вот они, азиатские степи… Однако скверная страна. До свиданья, Боше. Я тебе оставлю лучший дворец в Москве. До свиданья, желаю успеха. Видел императора? Ура! Ежели меня сделают губернатором в Индии, я тебя сделаю министром Кашмира… Ура! Император вот он! Видишь его? Я его два раза как тебя видел. Маленький капрал… Я видел, как он навесил крест одному из стариков… Ура, император!] – говорили голоса старых и молодых людей, самых разнообразных характеров и положений в обществе. На всех лицах этих людей было одно общее выражение радости о начале давно ожидаемого похода и восторга и преданности к человеку в сером сюртуке, стоявшему на горе.
| Тип | |
|---|---|
| Разработчик |
Sun Microsystems |
| Операционная система |
кроссплатформенная |
| Последняя версия |
1.50 |
| Лицензия | |
| Сайт |
[java.sun.com/j2se/javadoc/ n.com/j2se/javadoc/] |
Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc.
Javadoc также предоставляет API для создания доклетов и тэглетов, которые позволяют программисту анализировать структуру Java-приложения.
Содержание
Применение
Комментарии документации применяют для:
- документирования классов,
- интерфейсов,
- полей (переменных),
- конструкторов,
- методов,
- пакетов.
В каждом случае комментарий должен находиться перед документируемым элементом.
| Список дескрипторов Javadoc | ||
|---|---|---|
| Дескриптор | Описание | Применим к |
@author |
Автор | класс, интерфейс |
@version |
Версия. Не более одного дескриптора на класс | класс, интерфейс |
@since |
Указывает, с какой версии доступно | класс, интерфейс, поле, метод |
@see |
Ссылка на другое место в документации | класс, интерфейс, поле, метод |
@param |
Входной параметр метода | метод |
@return |
Описание возвращаемого значения | метод |
@exception имякласса описание |
Описание исключения, которое может быть послано из метода | метод |
@deprecated |
Описание устаревших блоков кода | класс, интерфейс, поле, метод |
{@link reference} |
Ссылка | класс, интерфейс, поле, метод |
{@value} |
Описание значения переменной | статичное поле |
Для документирования переменной можно использовать следующие дескрипторы:
@see, @serial, @serialField, {@value}, @deprecated.
Для классов и интерфейсов можно использовать дескрипторы:
@see, @author, @deprecated, @param, @version.
Методы можно документировать с помощью дескрипторов:
@see, @return, @param, @deprecated, @throws, @serialData, {@inheritDoc}, @ехсерtion.
Дескрипторы {@link}, {@docRoot}, {@code}, {@literal}, @since, {@linkplain} могут применяться где угодно.
Пример
Пример использования разметки Javadoc для документирования метода [2]. Типы переменных указывать не нужно.
/**
* <p>Проверяет, допустимый ли ход.</p>
* <p>Например, чтобы задать ход e2-e4, напишите isValidMove(5,2,5,4);
* Чтобы записать рокировку, укажите, откуда и куда ходит король.
* Например, для короткой рокировки чёрных запишите isValidMove(5,8,7,8);</p>
*
* @param fromCol Вертикаль, на которой находится фигура (1=a, 8=h)
* @param fromRow Горизонталь, на которой находится фигура (1...8)
* @param toCol Вертикаль клетки, на которую выполняется ход (1=a, 8=h)
* @param toRow Горизонталь клетки, на которую выполняется ход (1...8)
* @return true, если ход допустим, и false, если недопустим
*/
boolean isValidMove(int fromCol, int fromRow, int toCol, int toRow) {
. . .
}См. также
Напишите отзыв о статье "Javadoc"
Примечания
- ↑ [www.sun.com/software/opensource/java/faq.jsp#g30 Free and Open Source Java — FAQ] (англ.). Проверено 3 февраля 2010. [www.webcitation.org/65tawvVM4 Архивировано из первоисточника 3 марта 2012].
- ↑ [www.oracle.com/technetwork/java/javase/documentation/index-137868.html How to Write Doc Comments for the Javadoc Tool]
Ссылки
- [www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html Официальный сайт Javadoc] (англ.)
- [life-prog.ru/view_zam.php?id=71&cat=4&page=2 Java комментарии — Javadoc]
Статьи
- [www.ibm.com/developerworks/ru/library/j-jtp0821/index.html Теория и практика Java: Мне нужно задокументировать ЭТО?]
- [skipy.ru/useful/taglet.html Skipy.ru: Записки трезвого практика -> Полезное -> Создание собственных тегов javadoc]
|
Это заготовка статьи о свободном программном обеспечении. Вы можете помочь проекту, дополнив её. |
Отрывок, характеризующий Javadoc
29 го мая Наполеон выехал из Дрездена, где он пробыл три недели, окруженный двором, составленным из принцев, герцогов, королей и даже одного императора. Наполеон перед отъездом обласкал принцев, королей и императора, которые того заслуживали, побранил королей и принцев, которыми он был не вполне доволен, одарил своими собственными, то есть взятыми у других королей, жемчугами и бриллиантами императрицу австрийскую и, нежно обняв императрицу Марию Луизу, как говорит его историк, оставил ее огорченною разлукой, которую она – эта Мария Луиза, считавшаяся его супругой, несмотря на то, что в Париже оставалась другая супруга, – казалось, не в силах была перенести. Несмотря на то, что дипломаты еще твердо верили в возможность мира и усердно работали с этой целью, несмотря на то, что император Наполеон сам писал письмо императору Александру, называя его Monsieur mon frere [Государь брат мой] и искренно уверяя, что он не желает войны и что всегда будет любить и уважать его, – он ехал к армии и отдавал на каждой станции новые приказания, имевшие целью торопить движение армии от запада к востоку. Он ехал в дорожной карете, запряженной шестериком, окруженный пажами, адъютантами и конвоем, по тракту на Позен, Торн, Данциг и Кенигсберг. В каждом из этих городов тысячи людей с трепетом и восторгом встречали его.
Армия подвигалась с запада на восток, и переменные шестерни несли его туда же. 10 го июня он догнал армию и ночевал в Вильковисском лесу, в приготовленной для него квартире, в имении польского графа.
На другой день Наполеон, обогнав армию, в коляске подъехал к Неману и, с тем чтобы осмотреть местность переправы, переоделся в польский мундир и выехал на берег.
Увидав на той стороне казаков (les Cosaques) и расстилавшиеся степи (les Steppes), в середине которых была Moscou la ville sainte, [Москва, священный город,] столица того, подобного Скифскому, государства, куда ходил Александр Македонский, – Наполеон, неожиданно для всех и противно как стратегическим, так и дипломатическим соображениям, приказал наступление, и на другой день войска его стали переходить Неман.
12 го числа рано утром он вышел из палатки, раскинутой в этот день на крутом левом берегу Немана, и смотрел в зрительную трубу на выплывающие из Вильковисского леса потоки своих войск, разливающихся по трем мостам, наведенным на Немане. Войска знали о присутствии императора, искали его глазами, и, когда находили на горе перед палаткой отделившуюся от свиты фигуру в сюртуке и шляпе, они кидали вверх шапки, кричали: «Vive l'Empereur! [Да здравствует император!] – и одни за другими, не истощаясь, вытекали, всё вытекали из огромного, скрывавшего их доселе леса и, расстрояясь, по трем мостам переходили на ту сторону.
– On fera du chemin cette fois ci. Oh! quand il s'en mele lui meme ca chauffe… Nom de Dieu… Le voila!.. Vive l'Empereur! Les voila donc les Steppes de l'Asie! Vilain pays tout de meme. Au revoir, Beauche; je te reserve le plus beau palais de Moscou. Au revoir! Bonne chance… L'as tu vu, l'Empereur? Vive l'Empereur!.. preur! Si on me fait gouverneur aux Indes, Gerard, je te fais ministre du Cachemire, c'est arrete. Vive l'Empereur! Vive! vive! vive! Les gredins de Cosaques, comme ils filent. Vive l'Empereur! Le voila! Le vois tu? Je l'ai vu deux fois comme jete vois. Le petit caporal… Je l'ai vu donner la croix a l'un des vieux… Vive l'Empereur!.. [Теперь походим! О! как он сам возьмется, дело закипит. Ей богу… Вот он… Ура, император! Так вот они, азиатские степи… Однако скверная страна. До свиданья, Боше. Я тебе оставлю лучший дворец в Москве. До свиданья, желаю успеха. Видел императора? Ура! Ежели меня сделают губернатором в Индии, я тебя сделаю министром Кашмира… Ура! Император вот он! Видишь его? Я его два раза как тебя видел. Маленький капрал… Я видел, как он навесил крест одному из стариков… Ура, император!] – говорили голоса старых и молодых людей, самых разнообразных характеров и положений в обществе. На всех лицах этих людей было одно общее выражение радости о начале давно ожидаемого похода и восторга и преданности к человеку в сером сюртуке, стоявшему на горе.
