Сборка проектов и рефакторинг

Документирование javadoc

Дескрипторы javadoc

Дескрипторы полей

@deprecated description

@serialField name type description

@serial description

@value

@value package.class.element

@see link

@see package.class.element text

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

11 / 44

Документирование javadoc

Пример генерации документации javadoc

Пример

1

p u b l i c

c l a s s GCD {

2

/

3

4

Find

t h e

g r e a t e s t

common

d i v i s o r

o f

two

v a r i a b l e s ,

u s i n g t h e E u c l i d e a n a l g o r i t h m .

5

@author Gennadiy C h i s t y a k o v

6

@param arg0

F i r s t v a r i a b l e

7

@param arg1

Second

v a r i a b l e

8

@ r e t u r n

The

g r e a t e s t common

d i v i s o r

o f

arg0

and arg1

9

@throws

N e g a t i v e E x c e p t i o n

I f

one

o r

both

o f

t h e

10

/

argument

i s l e s s

than z e r o

11

p u b l i c

s t a t i c

long gcd ( long

arg0 , long

arg1 )

throws

N e g a t i v e E x c e p t i o n {

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

12 / 44

Документирование javadoc

Пример генерации документации javadoc

Пример (продолжение)

12	i f ( arg0	< 0 | | arg1 < 0)
13	throw new N e g a t i v e E x c e p t i o n ( ) ;
14	i f ( arg0	== 0)
15	r e t u r n arg1 ;
16	i f ( arg1	== 0)
17	r e t u r n arg0 ;
18	r e t u r n	gcd ( arg1 % arg0 , arg0 ) ;

19}

20}

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

13 / 44

Документирование javadoc

Результат генерации

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

14 / 44

Сборка проектов

1 Документирование

Общая информация javadoc

2 Сборка проектов

Общая информация

Сборка проектов с помощью Ant

3 Рефакторинг

4 Литература

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

15 / 44

Сборка проектов Общая информация

Скрипты для автоматизации

Понятие скрипта

Скрипт это программа, которая автоматизирует работу, которую иначе пользователь делал бы вручную.

Автоматизация повседневных операций

Скрипты

Специализированные программные средства

make Apache Ant

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

16 / 44

Сборка проектов Сборка проектов с помощью Ant

Средство автоматизации Apache Ant

Apache Ant

Утилита Ant была разработана как платформонезависимая замена утилиты make.

Переносимость сценариев обеспечивается за счет использования языка XML.

Основные структурные элементы. Свойства Проект

Цель

Задача

Кроме того, Ant позволяет использовать свойства аналог переменных в языках программирования.

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

17 / 44

Сборка проектов Сборка проектов с помощью Ant

Пример использования Ant

Пример

1	<?xml v e r s i o n=" 1.0 " encoding="UTF 8"?>
2	<p r o j e c t name=" e x a m p l e P r o j e c t " d e f a u l t=" f i n a l i z e ">

3<d e s c r i p t i o n>

4	This	i s a s i m p l e example u s i n g Ant
5	</ d e s c r i p t i o n>
6
7	<t a r g e t	name="makeJAR" depends=" compile , i n i t ">

8<j a r d e s t f i l e=" package ${DSTAMP} . j a r " b a s e d i r="tmp">

9<m a n i f e s t>

10<a t t r i b u t e name="Main c l a s s " v a l u e="Z"/>

11</ m a n i f e s t>

12</ j a r>

13</ t a r g e t>

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

18 / 44

Сборка проектов Сборка проектов с помощью Ant

Пример использования Ant

Пример (продолжение)

14<t a r g e t name=" compile " depends=" i n i t ">

15<j a v a c s r c d i r=" s r c " d e s t d i r="tmp" debug=" t r u e " i n c l u d e s=

	"Z . j a v a "/>
16	</ t a r g e t>
17
18	<t a r g e t	name=" i n i t ">
19	<mkdir	d i r="tmp"/>

20<tstamp />

21</ t a r g e t>

23<t a r g e t name=" f i n a l i z e " depends="makeJAR">

24<d e l e t e d i r="tmp"/>

25</ t a r g e t>

26</ p r o j e c t>

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

19 / 44

Рефакторинг

1 Документирование

Общая информация javadoc

2 Сборка проектов

Общая информация

Сборка проектов с помощью Ant

3 Рефакторинг

4 Литература

Г.А. Чистяков (ВятГУ)

РПС

20 сентября 2014 г.

20 / 44