tde-i18n-it/docs/tdevelop/tdevelop/documentation.docbook


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
>Documentazione</title>

<para
>Sfortunatamente la documentazione fa parte delle questioni più trascurate; tuttavia una volta impostata e mantenuta, la documentazione interna ed esterna fornisce un aiuto molto importante. </para>

<para
>La documentazione ha diversi aspetti. C'è <itemizedlist>
  <listitem
><para
><emphasis
>documentazione interna al progetto</emphasis
>, che consiste principalmente in <itemizedlist>
    <listitem
><para
><emphasis
>commenti</emphasis
> nei file header/sorgente </para
></listitem>
    <listitem
><para
><emphasis
>documentazione &API; interna</emphasis
> del proprio progetto generata da strumenti speciali come &eg; &doxygen; </para
></listitem>
  </itemizedlist>
  </para
></listitem>
  <listitem
><para
><emphasis
>documentazione esterna del progetto</emphasis
> che comprende <itemizedlist>
    <listitem
><para
><emphasis
>documentazione &API; esterna</emphasis
> &eg; di librerie di sistema (&kde; &Qt; &etc;) </para
></listitem>
    <listitem
><para
>altra documentazione (manuali di programmazione, informazioni generali di sistema, articoli HowTo e simili) </para
></listitem>
  </itemizedlist>
  </para
></listitem>
</itemizedlist>
</para>
<para
>Tutta questa documentazione dovrebbe essere manutenibile e a portata di mano ogni volta che serve. &tdevelop; ha la soluzione proprio per questo. </para>

<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->

<sect1 id="docbrowser">
<title
>Il browser della documentazione</title>


<figure id="screenshot-doctreeview" float="1">
<title
>Una schermata dell'albero della documentazione</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>

</sect1
> <!-- docbrowser -->

</chapter
> <!-- documentation -->