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
>Documentação</title>
<para
>A documentação, infelizmente, pertence às questões mais subestimadas da programação. Contudo, uma vez configurada devidamente e mantida a nível interno e externo, a documentação oferece uma ajuda muito valiosa. </para>
<para
>A documentação tem várias facetas. Existe a <itemizedlist>
<listitem
><para
><emphasis
>documentação interna do projecto</emphasis
>, que consiste principalmente em <itemizedlist>
<listitem
><para
><emphasis
>comentários</emphasis
> nos ficheiros de código/inclusão </para
></listitem>
<listitem
><para
><emphasis
>documentação interna da &API;</emphasis
> do seu projecto, gerada a partir dos ficheiros do programa com ferramentas especiais, ⪚ &doxygen; </para
></listitem>
</itemizedlist>
</para
></listitem>
<listitem
><para
><emphasis
>documentação externa do projecto</emphasis
>, que inclui, entre outras <itemizedlist>
<listitem
><para
><emphasis
>a documentação externa da &API;</emphasis
> de ⪚ bibliotecas do sistema comuns (&kde;, &Qt;, &etc;) </para
></listitem>
<listitem
><para
>qualquer outra documentação (manuais da linguagem de programação, informação de sistema geral, artigos e tutoriais, entre outros) </para
></listitem>
</itemizedlist>
</para
></listitem>
</itemizedlist>
</para>
<para
>Toda esta documentação deverá ser fácil de manter e prontamente disponível sempre que necessitar dela. O &tdevelop; tem todas as capacidades para tal. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title
>O Navegador de Documentação</title>
<figure id="screenshot-doctreeview" float="1">
<title
>Uma Imagem da Árvore de Documentação</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1
> <!-- docbrowser -->
</chapter
> <!-- documentation -->
|
