Сборка проектов и рефакторинг
.pdf
Разработка программных систем
Документирование и сборка проектов Рефакторинг
Геннадий Андреевич Чистяков
Вятский государственный университет
20 сентября 2014 г.
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
1 / 44 |
1 Документирование
Общая информация 
javadoc
2 Сборка проектов
Общая информация
Сборка проектов с помощью Ant
3 Рефакторинг
4 Литература
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
2 / 44 |
Документирование
1 Документирование
Общая информация 
javadoc
2 Сборка проектов
Общая информация
Сборка проектов с помощью Ant
3 Рефакторинг
4 Литература
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
3 / 44 |
Документирование Общая информация
Процесс документирования
Цель процесса 
Документирование это процесс создания технической документации.
Цель данного процесса получение документов на программный продукт, которые в необходимой степени описывают то, как работает программный продукт, и то, как им пользоваться.
Типы документации 
Проектная
Техническая
Пользовательская
Маркетинговая
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
4 / 44 |
Документирование Общая информация
Техническая документация
Назначение
Техническая документация это текст, сопровождающий программный код и описывающий различные аспекты того, что именно делает код.
Автоматическая генерация документации 
Для генерации технической документации часто применяются специализированные средства. Наиболее известные:
Doxygen
Epydoc
Sandcastle
javadoc
XHelpGen
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
5 / 44 |
Документирование Общая информация
Пользовательская документация
Назначение
Пользовательская документация представляет собой руководство, в котором описаны основные функции программы и приведены пошаговые инструкции, необходимые для использование этих функций.
Основные типы пользовательской документации 
Вводное руководство
Тематическое разделение на главы
Алфавитный справочник-указатель
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
6 / 44 |
Документирование javadoc
Средство генерации документации javadoc
javadoc
javadoc генератор документации в формате HTML из комментариев исходных кодов на Java.
Возможности применения Документирование:
Классов
Интерфейсов
Пакетов
Полей и переменных
Методов
Конструкторов
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
7 / 44 |
Документирование javadoc
Дескрипторы javadoc
Универсальные дескрипторы
@docRoot
@code code
@link package.class.element text
@linkplain package.class.element text
@literal text
@since version
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
8 / 44 |
Документирование javadoc
Дескрипторы javadoc
Дескрипторы классов и интерфейсов
@author name
@version information
@deprecated description
@see link
@see package.class.element text
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
9 / 44 |
Документирование javadoc
Дескрипторы javadoc
Дескрипторы методов
@deprecated description
@exception exception description
@throws exception description
@inheritDoc
@param name description
@return description
@see link
@see package.class.element text
@serialData description
Г.А. Чистяков (ВятГУ) |
РПС |
20 сентября 2014 г. |
10 / 44 |