blob: 01f9d21c4e9203128c3c3a318553bb35fb9b52af (
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 ä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>
<para
>Dokumentation har flera aspekter. Det finns <itemizedlist>
<listitem
><para
><emphasis
>intern projektdokumentation</emphasis
>, som i huvudsak består av <itemizedlist>
<listitem
><para
><emphasis
>kommentarer</emphasis
> i deklarationsfiler och källkodsfiler </para
></listitem>
<listitem
><para
><emphasis
>Intern dokumentation av programmeringsgränssnittet</emphasis
> för projektet, som har skapats från programfilerna av särskilda verktyg, t.ex. &doxygen; </para
></listitem>
</itemizedlist>
</para
></listitem>
<listitem
><para
><emphasis
>extern projektdokumentation</emphasis
>, som bland annat består av <itemizedlist>
<listitem
><para
><emphasis
>extern dokumentation av programmeringsgränssnitt</emphasis
>, till exempel för gemensamma systembibliotek (&kde;, &Qt;, etc.) </para
></listitem>
<listitem
><para
>all övrig dokumentation (manualer för programspråk, allmän systeminformation, handledningar och liknande) </para
></listitem>
</itemizedlist>
</para
></listitem>
</itemizedlist>
</para>
<para
>All denna dokumentation ska vara enkel att underhålla och lätt tillgänglig så fort du behöver den. &tdevelop; har stöd för just detta. </para>
<!-- ### doc browser, notes on internal documentation, how to profit from Doxygen -->
<sect1 id="docbrowser">
<title
>Dokumentationsbläddraren</title>
<figure id="screenshot-doctreeview" float="1">
<title
>En skärmbild av dokumentationsträdet</title>
<mediaobject>
<imageobject
><imagedata fileref="doctreeview.png"/></imageobject>
</mediaobject>
</figure>
</sect1
> <!-- docbrowser -->
</chapter
> <!-- documentation -->
|
