1
<chapter id="documentation">
6
>Dokumentation är tyvärr en av de mest förbisedda delarna av programmering. Ändå så erbjuder riktigt upprättad och underhållen intern och extern dokumentation ytterst värdefull hjälp. </para>
9
>Dokumentation har flera aspekter. Det finns <itemizedlist>
13
>intern projektdokumentation</emphasis
14
>, som i huvudsak består av <itemizedlist>
18
>kommentarer</emphasis
19
> i deklarationsfiler och källkodsfiler </para
24
>Intern dokumentation av programmeringsgränssnittet</emphasis
25
> för projektet, som har skapats från programfilerna av särskilda verktyg, t.ex. &doxygen; </para
33
>extern projektdokumentation</emphasis
34
>, som bland annat består av <itemizedlist>
38
>extern dokumentation av programmeringsgränssnitt</emphasis
39
>, till exempel för gemensamma systembibliotek (&kde;, &Qt;, etc.) </para
43
>all övrig dokumentation (manualer för programspråk, allmän systeminformation, handledningar och liknande) </para
51
>All denna dokumentation ska vara enkel att underhålla och lätt tillgänglig så fort du behöver den. &kdevelop; har stöd för just detta. </para>
53
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
55
<sect1 id="docbrowser">
57
>Dokumentationsbläddraren</title>
60
<figure id="screenshot-doctreeview" float="1">
62
>En skärmbild av dokumentationsträdet</title>
65
><imagedata fileref="doctreeview.png"/></imageobject>
73
> <!-- documentation -->