<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 ⪚ &doxygen; </para ></listitem> </itemizedlist> </para ></listitem> <listitem ><para ><emphasis >documentazione esterna del progetto</emphasis > che comprende <itemizedlist> <listitem ><para ><emphasis >documentazione &API; esterna</emphasis > ⪚ 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. &kdevelop; 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 -->