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
|
<chapter id="documentation">
<title>Documentación</title>
<para>La documentación, desafortunadamente, es una de las cuestiones menos tenidas en cuenta en programación. Aún así, una vez configurada y bien mantenida, la documentación tanto interna como externa proporciona una ayuda inestimable. </para>
<para>La documentación posee múltiples aspectos. Existe <itemizedlist>
<listitem><para><emphasis>documentación interna del proyecto</emphasis>, consistente principalmente en <itemizedlist>
<listitem><para><emphasis>comentarios</emphasis> en archivos de cabecera y de código fuente </para></listitem>
<listitem><para><emphasis>documentación de la &API; interna</emphasis> de su proyecto generada a partir de los archivos de código fuente de su programa por herramientas especiales, como &doxygen; </para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para><emphasis>documentación externa del proyecto</emphasis>, que comprende, entre otros, <itemizedlist>
<listitem><para><emphasis>documentación de la &API; externa</emphasis> de, ⪚, bibliotecas comunes del sistema (&kde;, &Qt;, &etc;) </para></listitem>
<listitem><para>cualquier otra documentación (manuales de lenguajes de programación, información general del sistema, artículos «cómo», y similares) </para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
</para>
<para>Toda esta documentación debe ser fácil de mantener y estar disponible rápidamente cada vez que la necesite. &tdevelop; proporciona precisamente eso. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title>El navegador de la documentación</title>
<figure id="screenshot-doctreeview" float="1">
<title>Una captura del árbol de la documentación</title>
<mediaobject>
<imageobject><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1> <!-- docbrowser -->
</chapter> <!-- documentation -->
|
