1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
<chapter id="documentation">
<title
>Документирование</title>
<para
>К несчастью, написание документации часто бывает сложнее написания кода. Но продуманно организованная и понятно написанная, она оказывает значительную помощь в разработке, позволяющую не обращаться лишний раз за советом на форумы, или, что ещё лучше, к автору. </para>
<para
>Документирование имеет несколько граней. Это <itemizedlist>
<listitem
><para
><emphasis
>внутренняя документация проекта</emphasis
>, состоящая в основном из <itemizedlist>
<listitem
><para
><emphasis
>комментариев</emphasis
> в исходных файлах </para
></listitem>
<listitem
><para
><emphasis
>внутренняя &API;-документация</emphasis
>, генерируемая специальными инструментами, такими как &doxygen; </para
></listitem>
</itemizedlist>
</para
></listitem>
<listitem
><para
><emphasis
>внешняя документация проекта</emphasis
> <itemizedlist>
<listitem
><para
><emphasis
>внешняя &API;-документация</emphasis
>, например по функциям библиотек (&kde;, &Qt; и т.д.) </para
></listitem>
<listitem
><para
>другая документация (по языкам программирования, статьи HOWTO, общая системная информация) </para
></listitem>
</itemizedlist>
</para
></listitem>
</itemizedlist>
</para>
<para
>Вся указанная документация должна быть удобна и легко доступна, когда она понадобится. &kdevelop; предлагает гибкое решение для этого. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title
>Обзор документации</title>
<figure id="screenshot-doctreeview" float="1">
<title
>Снимок экрана структуры документации</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1
> <!-- docbrowser -->
</chapter
> <!-- documentation -->
|
