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>Documentation</title>
<para>La documentation appartient malheureusement aux aspects les plus négligés en matière de programmation. Pourtant, une fois correctement configurée et maintenue, la documentation interne et externe fournit une aide des plus précieuses. </para>
<para>La documentation a des facettes multiples. Il y a <itemizedlist>
<listitem><para>la <emphasis>documentation interne au projet</emphasis>, composée principalement <itemizedlist>
<listitem><para>des <emphasis>commentaires</emphasis> dans les fichiers sources / d'en-têtes </para></listitem>
<listitem><para>la <emphasis>documentation de l'&API; interne</emphasis> de votre projet, générée depuis le fichier de programme par des outils spéciaux, &pex; &doxygen; </para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>la <emphasis>documentation externe au projet</emphasis>, comprenant entre autres <itemizedlist>
<listitem><para>la <emphasis>documentation de l'&API; externe</emphasis> &pex; les bibliothèques système courantes (&kde;, &Qt;, &etc;) </para></listitem>
<listitem><para>toute autre documentation (manuels de langages de programmation, informations générales sur le système, articles « how-to »,&etc;) </para></listitem>
</itemizedlist>
</para></listitem>
</itemizedlist>
</para>
<para>Toute cette documentation devra être facile à maintenir et à portée de la main, à chaque fois que vous en avez besoin. &tdevelop; a des ressources simplement pour cela. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title>Le navigateur de documentation</title>
<figure id="screenshot-doctreeview" float="1">
<title>Une copie d'écran de l'arborescence de la Documentation</title>
<mediaobject>
<imageobject><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1> <!-- docbrowser -->
</chapter> <!-- documentation -->
|
