0
<ul><ul><li>Малышкин Фёдор </li></ul></ul><ul><ul><li>11 октября 2007 </li></ul></ul>Документирование исходных текстов
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
Основание  для ведения документации <ul><li>Возобновление работы над проектом после продолжительного перерыва  </li></ul><...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
Требования к документации <ul><li>Не документировать очевидные вещи (setter'ы и getter'ы, циклы по массивам и листам, выво...
Требования к документации <ul><li>Поддерживать документацию в актуальном состоянии </li></ul>/** * Произвести парсинг исто...
Требования к документации <ul><li>Описывать входящие параметры, если нужно </li></ul>/** * Создание нового экземпляра ядра...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
JavaDoc'и: Обзор <ul><li>Это просто текст обрамлённый особыми комментариями. Они могут описывать классы, методы и переменн...
JavaDoc'и: Обзор <ul><li>Структура каждого javadoc коментария такова: </li></ul><ul><ul><li>Первая строчка, которая попада...
JavaDoc'и: Обзор
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
JavaDoc'и: Тэги <ul><li>@see – ссылка на дополнительные классы или пакеты (все ссылки оформляются в виде: «packageName.cla...
JavaDoc'и: Тэги <ul><li>@author – автор кода </li></ul><ul><ul><li>@author Mary Wollstonecraft </li></ul></ul><ul><ul><li>...
JavaDoc'и: Тэги <ul><li>@link – позволяет сделать ссылку на другой класс, метод или пакет. Обратите внимание на фигурные с...
JavaDoc'и: Обзор <ul><ul><li>Есть возможность применять комментарии для пакетов. Для этого необходимо поместить файл packa...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
JavaDoc'и: Примеры <ul><li>/** </li></ul><ul><li>* Представитель модуля EntityManger на клиентской стороне. </li></ul><ul>...
JavaDoc'и: Примеры <ul><li>/** </li></ul><ul><li>* Произвести запись нового объекта. </li></ul><ul><li>*  </li></ul><ul><l...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
Maven 2 & JavaDoc'и <ul><li>Поддержка генерации javadoc </li></ul><ul><li>Настраиваемые в pom.xml параметры для генерации ...
Maven 2 & JavaDoc'и <ul><li>Для генерации javadoc'ов в существует plugin javadoc: </li></ul><ul><ul><li>$malyshkiknf> mvn ...
Maven 2 & JavaDoc'и <ul><li>Возможно объединить javadoc'и от нескольких дочерних проектов. Для этого нужно откорректироват...
Maven 2 & JavaDoc'и <ul><li>Можно группировать пакеты по сходному назначению или использованию в группы. </li></ul><ul><ul...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
NetBeans & JavaDoc'и <ul><li>Просмотр JavaDoc'ов в отдельном окне и в контекстом  </li></ul><ul><li>Помощь в генерации Jav...
NetBeans & JavaDoc'и <ul><li>Для активации поддержки JavaDoc'ов необходимо кое-что включить в NetBeans </li></ul>
NetBeans & JavaDoc'и <ul><li>Отдельное окно с информацией о JavaDoc </li></ul>
NetBeans & JavaDoc'и <ul><li>Контекстно меню. Как обычно при нажатии Ctrl+Space... </li></ul>
NetBeans & JavaDoc'и <ul><li>Помощь в генераци JavaDoc.  </li></ul><ul><li>Наводим курсор на определение класса и ждём... ...
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
Ресурсы для JavaDoc'ов <ul><li>HTTP Server на mg-sv01 и шара g-sv01javadocs </li></ul>
<ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></...
TODO <ul><li>Подобно многим другим средам разработки NetBeans позволяет оставлять особые коментарии в исходных текстах, ко...
Upcoming SlideShare
Loading in...5
×

Документирование исходных текстов (javadoc)

11,895

Published on

Документирование исходных текстов (javadoc)

Published in: Technology
0 Comments
5 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total Views
11,895
On Slideshare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
108
Comments
0
Likes
5
Embeds 0
No embeds

No notes for slide

Transcript of "Документирование исходных текстов (javadoc)"

  1. 1. <ul><ul><li>Малышкин Фёдор </li></ul></ul><ul><ul><li>11 октября 2007 </li></ul></ul>Документирование исходных текстов
  2. 2. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  3. 3. Основание для ведения документации <ul><li>Возобновление работы над проектом после продолжительного перерыва </li></ul><ul><li>Переход проекта от одного человека (группы) к другому человеку (группе) </li></ul><ul><li>Опубликование проекта для Open Source сообщества </li></ul><ul><li>Совместная работа большой группы людей над одним проектом </li></ul>
  4. 4. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  5. 5. Требования к документации <ul><li>Не документировать очевидные вещи (setter'ы и getter'ы, циклы по массивам и листам, вывод логов и прочее) </li></ul>/** * Проверка: редактируема ли даннная ячейка. * * <p>В случае если данная ячаейка редактируема - возвращается true</p> * * <p>В случае если данная ячаейка не редактируема - возвращается false</p> * * @param column номер колонки для проверки * @return результат проверки **/ public boolean isCellEditable(int column) { return column % 2 == 0 ? true : false; }
  6. 6. Требования к документации <ul><li>Поддерживать документацию в актуальном состоянии </li></ul>/** * Произвести парсинг истории операций над невстроенной БД. * * * @throws XMLConfigurationParsingException */ public void parseHistoryNotEmbeddedDB() throws XMLConfigurationParsingException { return ; /* * InputStream is = * Thread.currentThread().GetContextClassLoader(). getResourceAsStream(&quot;ru/magnetosoft/magnet/em/cfg/db-configuration-not-embedded.xml&quot;); * String configXml = readStringFromStream(is); * XmlConfigurationParserImpl parser = new * XmlConfigurationParserImpl(configXml); IEmConfiguration res = * parser.parse(); assertNotNull(res); * assertFalse(res.getOperationHistoryStorageConfiguration().isEmbeddedStorage()); * assertEquals(&quot;HSQLDB&quot;, * res.getOperationHistoryStorageConfiguration().getStorageDBType()); */ }
  7. 7. Требования к документации <ul><li>Описывать входящие параметры, если нужно </li></ul>/** * Создание нового экземпляра ядра. * * * @param contextName * @param objectRelationManager * @param xmlObjectPersister * @param ohm * @param snm * @param initializationLatch * @return */ public static EmEngine newInstance(String contextName, IXmlObjectRelationManager objectRelationManager, IXmlObjectPersister xmlObjectPersister, OperationHistoryManager ohm, ISearchNotificationManager snm, CountDownLatch initializationLatch) { ... ... }
  8. 8. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  9. 9. JavaDoc'и: Обзор <ul><li>Это просто текст обрамлённый особыми комментариями. Они могут описывать классы, методы и переменные класса. </li></ul><ul><li>Например: </li></ul><ul><li>/** </li></ul><ul><li>Текст </li></ul><ul><li>**/ </li></ul><ul><li>Он может включать в себя HTML тэги и специальные javadoc тэги, которые позволяют включать дополнительную информацию и ссылки. </li></ul><ul><li>/** </li></ul><ul><li>Вставка объектов в очередь. </li></ul><ul><li><p>Вставка объектов в конец очереди, но только если нет таких же экземпляров<p>. </li></ul><ul><li>@since 0.2 </li></ul><ul><li>@author Malyshkin Fedor ( [email_address] ) **/ </li></ul>
  10. 10. JavaDoc'и: Обзор <ul><li>Структура каждого javadoc коментария такова: </li></ul><ul><ul><li>Первая строчка, которая попадает в краткое описание класса (отделяется точкой и пустой строкой). </li></ul></ul><ul><ul><li>Основной текст, который вместе с HTML тэгами кописруется в основную документацию. </li></ul></ul><ul><ul><li>Входящие параметры (если есть) </li></ul></ul><ul><ul><li>Выбрасываемые исключения (если есть) </li></ul></ul><ul><ul><li>Возвращаемое значение (если есть) </li></ul></ul><ul><ul><li>Служебные Javadoc тэги </li></ul></ul>
  11. 11. JavaDoc'и: Обзор
  12. 12. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  13. 13. JavaDoc'и: Тэги <ul><li>@see – ссылка на дополнительные классы или пакеты (все ссылки оформляются в виде: «packageName.className#methodName(argument1, argument2,...)», где пакет указывается лишь в случае если ссылаемся на класс в другом пакете, а аргументы (т.е. типы аргументов) – лишь в случае если есть метод с тем же именем). Т.е. можно написать так: </li></ul><ul><ul><li>@see java.io.RandomAccessFile#RandomAccessFile(File, String) </li></ul></ul><ul><ul><li>а можно и так: </li></ul></ul><ul><ul><li>@see CreationManager </li></ul></ul>
  14. 14. JavaDoc'и: Тэги <ul><li>@author – автор кода </li></ul><ul><ul><li>@author Mary Wollstonecraft </li></ul></ul><ul><ul><li>@author Jack Kent, Peggy Parish, Crockett Johnson </li></ul></ul><ul><li>@version – версия продукта (если нужно) </li></ul><ul><ul><li>@version 493.0.1beta </li></ul></ul><ul><li>@since – с какой версии появлось в продукте </li></ul><ul><ul><li>@since 493.0.1beta </li></ul></ul><ul><li>@param – (с именем параметра) описание входящего параметра </li></ul><ul><ul><li>@param column номер колонки для проверки </li></ul></ul><ul><ul><li>@param row номер ряда для проверки </li></ul></ul><ul><li>@return – описание возвращаемого значения </li></ul><ul><li>@throws – (с типом исключения) описание исключения </li></ul><ul><ul><li>@throws XmlMagnetException </li></ul></ul><ul><ul><li>@throws EntityManagerException </li></ul></ul>
  15. 15. JavaDoc'и: Тэги <ul><li>@link – позволяет сделать ссылку на другой класс, метод или пакет. Обратите внимание на фигурные скобки. </li></ul><ul><ul><li>{@link #getInstance(InputStream)} </li></ul></ul><ul><ul><li>{@link #getInstance(String)} </li></ul></ul><ul><ul><li>{@link java.io.InputStream(String)} </li></ul></ul>
  16. 16. JavaDoc'и: Обзор <ul><ul><li>Есть возможность применять комментарии для пакетов. Для этого необходимо поместить файл package.html в пакет с исходными текстами. </li></ul></ul><ul><ul><li>Данный файл должен быть обычным HTML файлом с тэгом <BODY>. </li></ul></ul><ul><ul><li>Первая строчка файла до точки идёт в краткое описание пакета, а полное описание идёт вниз – под список всех классов и исключений. </li></ul></ul><ul><ul><li>Этот функционал позволяет описать что-то, что невозможно описать с помощью конкретных классов. </li></ul></ul>
  17. 17. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  18. 18. JavaDoc'и: Примеры <ul><li>/** </li></ul><ul><li>* Представитель модуля EntityManger на клиентской стороне. </li></ul><ul><li>* </li></ul><ul><li>* <p> </li></ul><ul><li>* Данный класс представляет средства доступ к возможностям модуля </li></ul><ul><li>* EntityManager, минуя прямые вызовы веб-сервисов. </li></ul><ul><li>* </p> </li></ul><ul><li>* <p> </li></ul><ul><li>* Он самостоятельно преобразовывает ваши Java Bean'ы в XML и производит </li></ul><ul><li>* обратную операцию, при получении ответа от модуля. </li></ul><ul><li>* </p> </li></ul><ul><li>* <p> </li></ul><ul><li>* Для получения экземпляра данного класса предназначены статические методы </li></ul><ul><li>* {@link #getInstance(InputStream)} и {@link #getInstance(String)} </li></ul><ul><li>* </p> </li></ul><ul><li>* </li></ul><ul><li>* @created 09.11.2006 </li></ul><ul><li>* @version $Revision 738 $ </li></ul><ul><li>* @author MalyshkinF </li></ul><ul><li>* @since 0.2.2 </li></ul><ul><li>*/ </li></ul><ul><li>public class EntityManagerInvoker { </li></ul>
  19. 19. JavaDoc'и: Примеры <ul><li>/** </li></ul><ul><li>* Произвести запись нового объекта. </li></ul><ul><li>* </li></ul><ul><li>* Произвести запись нового объекта. Тип для сохранения может быть </li></ul><ul><li>* подклассом List (для реализации возможности работы с несколькими </li></ul><ul><li>* объектами) или единичным объектом. В случае если произошла какая-либо </li></ul><ul><li>* ошибка - выбрасывается исключение. В данном случае с базой не происходит </li></ul><ul><li>* никаких изменений и ни один объект не был затрагивается предполагаемой </li></ul><ul><li>* операцией. Конкретный тип ошибки можно определить проверкой конкретного </li></ul><ul><li>* возвращённого исключения. </li></ul><ul><li>* </li></ul><ul><li>* @param object </li></ul><ul><li>* сохраняемый объект/объекты. </li></ul><ul><li>* @return сохраненный объект/объекты </li></ul><ul><li>* @throws XmlMagnetException ошибка в процессе парсинга XML </li></ul><ul><li>* @throws EntityManagerException ошибка связанная с другой работой клиента </li></ul><ul><li>*/ </li></ul><ul><li>public Object insert(Object object) throws XmlMagnetException, EntityManagerException { </li></ul>
  20. 20. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  21. 21. Maven 2 & JavaDoc'и <ul><li>Поддержка генерации javadoc </li></ul><ul><li>Настраиваемые в pom.xml параметры для генерации javadoc </li></ul><ul><li>Автоматическая генерация и закачка в репозитарий javadoc'ов при создании релиза </li></ul><ul><li>... </li></ul>
  22. 22. Maven 2 & JavaDoc'и <ul><li>Для генерации javadoc'ов в существует plugin javadoc: </li></ul><ul><ul><li>$malyshkiknf> mvn javadoc:javadoc </li></ul></ul><ul><li>Для автоматической генерации при каждой сборке необходимо добавить в корневой тэг такой XML: </li></ul><ul><li><reporting> </li></ul><ul><ul><li>... </li></ul></ul><ul><li><plugins> </li></ul><ul><ul><ul><li>... </li></ul></ul></ul><ul><li><plugin> </li></ul><ul><li><groupId>org.apache.maven.plugins</groupId> </li></ul><ul><li><artifactId>maven-javadoc-plugin</artifactId> </li></ul><ul><li></plugin> </li></ul><ul><ul><ul><li>... </li></ul></ul></ul><ul><li></plugins> </li></ul><ul><li>... </li></ul><ul><li></reporting> </li></ul>
  23. 23. Maven 2 & JavaDoc'и <ul><li>Возможно объединить javadoc'и от нескольких дочерних проектов. Для этого нужно откорректировать корневой pom.xml. </li></ul><ul><ul><li><reporting> </li></ul></ul><ul><ul><ul><li>... </li></ul></ul></ul><ul><ul><li><plugins> </li></ul></ul><ul><ul><ul><li>... </li></ul></ul></ul><ul><ul><li><plugin> </li></ul></ul><ul><ul><li><groupId>org.apache.maven.plugins</groupId> </li></ul></ul><ul><ul><li><artifactId>maven-javadoc-plugin</artifactId> </li></ul></ul><ul><ul><li><configuration> </li></ul></ul><ul><ul><li>... </li></ul></ul><ul><ul><li><aggregate>true</aggregate> </li></ul></ul><ul><ul><li>... </li></ul></ul><ul><ul><li></configuration> </li></ul></ul><ul><ul><li></plugin> </li></ul></ul><ul><ul><ul><li>... </li></ul></ul></ul><ul><ul><li></plugins> </li></ul></ul><ul><ul><li>... </li></ul></ul><ul><ul><li></reporting> </li></ul></ul>
  24. 24. Maven 2 & JavaDoc'и <ul><li>Можно группировать пакеты по сходному назначению или использованию в группы. </li></ul><ul><ul><li><groups> </li></ul></ul><ul><ul><ul><li><group> </li></ul></ul></ul><ul><ul><ul><ul><li><title>Clients Part</title> <packages>ru.magnetosoft.magnet.em.client: </li></ul></ul></ul></ul><ul><ul><ul><ul><li>ru.magnetosoft.magnet.em.client.cfg</packages> </li></ul></ul></ul></ul><ul><ul><ul><li></group> </li></ul></ul></ul><ul><li><group> </li></ul><ul><li><title>Common Part</title> </li></ul><ul><ul><ul><ul><li><packages>ru.magnetosoft.magnet.em.annotations: </li></ul></ul></ul></ul><ul><ul><ul><ul><ul><li>ru.magnetosoft.magnet.em.metadata: </li></ul></ul></ul></ul></ul><ul><ul><ul><ul><ul><li>ru.magnetosoft.magnet.em.xml: </li></ul></ul></ul></ul></ul><ul><ul><ul><ul><ul><li>ru.magnetosoft.magnet.em.xml.parts: </li></ul></ul></ul></ul></ul><ul><ul><ul><ul><ul><li>ru.magnetosoft.magnet.em.xml.parts.v2: </li></ul></ul></ul></ul></ul><ul><ul><ul><ul><ul><li></packages> </li></ul></ul></ul></ul></ul><ul><ul><ul><li></group> </li></ul></ul></ul><ul><ul><li></groups> </li></ul></ul>
  25. 25. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  26. 26. NetBeans & JavaDoc'и <ul><li>Просмотр JavaDoc'ов в отдельном окне и в контекстом </li></ul><ul><li>Помощь в генерации JavaDoc'ов </li></ul><ul><li>Возможность подключения JavaDoc'ов к используемым библиотекам </li></ul><ul><li>P.S.: Примеры будут показываться на NetBeans 6 </li></ul>
  27. 27. NetBeans & JavaDoc'и <ul><li>Для активации поддержки JavaDoc'ов необходимо кое-что включить в NetBeans </li></ul>
  28. 28. NetBeans & JavaDoc'и <ul><li>Отдельное окно с информацией о JavaDoc </li></ul>
  29. 29. NetBeans & JavaDoc'и <ul><li>Контекстно меню. Как обычно при нажатии Ctrl+Space... </li></ul>
  30. 30. NetBeans & JavaDoc'и <ul><li>Помощь в генераци JavaDoc. </li></ul><ul><li>Наводим курсор на определение класса и ждём... </li></ul><ul><ul><li>Нажимаем на лампочку .... </li></ul></ul>Вуаля...
  31. 31. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  32. 32. Ресурсы для JavaDoc'ов <ul><li>HTTP Server на mg-sv01 и шара g-sv01javadocs </li></ul>
  33. 33. <ul><li>Основание для ведения документации </li></ul><ul><li>Требования к документации </li></ul><ul><li>JavaDoc'и </li></ul><ul><ul><li>Обзор </li></ul></ul><ul><ul><li>Тэги </li></ul></ul><ul><ul><li>Примеры </li></ul></ul><ul><ul><li>Maven2 & JavaDoc'и </li></ul></ul><ul><ul><li>NetBeans & JavaDoc'и </li></ul></ul><ul><ul><li>Ресурсы для JavaDoc'ов в сети фирмы </li></ul></ul><ul><li>Дополнительная документация </li></ul><ul><ul><li>TODO </li></ul></ul>Оглавление
  34. 34. TODO <ul><li>Подобно многим другим средам разработки NetBeans позволяет оставлять особые коментарии в исходных текстах, которые могут быть собраны и выведены на экран. Это могут быть личные заметки о необходимости дополнительной проверки кода, переработки в дальнейшем и прочие записи. </li></ul>
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×