blob: a82e84059db9a5daf41e9c3f95b8cff5b967f913 (
plain)
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
>Dokumentation</title>
<para
>Dokumentation hører desværre til de mere oversete ting i programmering. Alligevel så yder korrekt oprettet og vedligeholdt intern og ekstern dokumentation, yderst værdifuld hjælp. </para>
<para
>Dokumentation har flere aspekter. Der er <itemizedlist>
<listitem
><para
><emphasis
>intern projektdokumentation</emphasis
>, som hovedsageligt består af <itemizedlist>
<listitem
><para
><emphasis
>kommentarer</emphasis
> i deklarationsfiler og kildekodefiler </para
></listitem>
<listitem
><para
><emphasis
>Intern dokumentation af programmeringsgrænsefladen</emphasis
> for projektet, som er lavet ud fra programfilerne af særlige værktøjer, f.eks. &doxygen; </para
></listitem>
</itemizedlist>
</para
></listitem>
<listitem
><para
><emphasis
>ekstern projektdokumentation</emphasis
>, som blandt andet består af <itemizedlist>
<listitem
><para
><emphasis
>ekstern dokumentation af programmeringsgrænseflade</emphasis
>, for eksempel for fælles systembiblioteker (&kde;, &Qt;, etc.) </para
></listitem>
<listitem
><para
>al øvrig dokumentation (manualer for programmeringssprog, almen systeminformation, vejledninger og lignende) </para
></listitem>
</itemizedlist>
</para
></listitem>
</itemizedlist>
</para>
<para
>Al denne dokumentation skal være enkel at vedligeholde og let tilgængelig så snart du behøver den. &tdevelop; har støtte for netop dette. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title
>Dokumentationssøgeren</title>
<figure id="screenshot-doctreeview" float="1">
<title
>Et skærmaftryk af dokumentationstræet</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1
> <!-- docbrowser -->
</chapter
> <!-- documentation -->
|
