Wie mache ich bei einer Dokumentation mit Doxygen eine Art Dekblatt, bzw. Hauptseite (für die HTML Version).
Dort sollte dann Erläuterungen zu meinem Makefile sein und eine zu einem Shellskript. Außerdem ein paar Zusatzinfos über das Programm und Aufrufe, also eine menge Informationen, die aber nichts mit dem Quelltext zu tun haben.
Kommentare innerhalb des Quelltextes anzeigen.
Diese werden in der Doku erst nach dem Quelltext erläutert:
unsigned int abstand\_ab
code...
code...
code...
code...
code...
code...
code...
code...
///If um negatives ergebnis zu vermeiden, da uint
if (a\>b){
abstand\_ab= a-b;
} else {
abstand\_ab=b-a;
}
In der Doku steht:
unsigned int abstand\_ab
code...
if (a\>b){
abstand\_ab= a-b;
} else {
abstand\_ab=b-a;
}
-------------------
If um negatives ergebnis zu vermeiden, da uint
Man sieht nicht den direkten Bezug von Kommentar und Codestelle.
Lieber wäre es mir, wenn an der Stelle, wo ich das Kommentar eingefügt habe ain art Kasten ist, in dem mein Kommentar steht.
Vieleicht in dem Einfach Text umrahmt wird, also in html ausgdrückt:
Kann ich einzelene Codeabschnitte von der Dokumentatation ausschließen?
Statt:
Name[0]= "Hans"
Name[1]= "Heinz"
Name[2]= "Aiche"
Name[3]= "Biggi"
Name[4]= "Suse"
Name[5]= "Ewald"
Name[6]= "Hans2"
Name[7]= "Hans3"
Name[8]= "Hans4"
Name[9]= "Hans5"
Name[10]= "Hans6"
Name[11]= "Hans7"
Name[12]= "Hans8"
würde es ja genügen, wenn da stehen würde: (Phantasiesyntax!)
///Ablegen der Namen in einenm Array. Beispiel:
Name[0]= "Hans"
/// ...
///\nodoxy
Name[1]= "Heinz"
Name[2]= "Aiche"
Name[3]= "Biggi"
Name[4]= "Suse"
Name[5]= "Ewald"
Name[6]= "Hans2"
Name[7]= "Hans3"
Name[8]= "Hans4"
Name[9]= "Hans5"
Name[10]= "Hans6"
Name[11]= "Hans7"
Name[12]= "Hans8"
///\doxy
printf("%s\n", "Weiterer Code");
Und später steht dann in der Doku:
**Ablegen der Namen in einenm Array.
Beispiel:**
Name[0]= "Hans";
...
printf("%s\n", "Weiterer Code");
Sauberes RTF erzeugen:
Die Überschfiften der RTF Doku sehen Wie folgt aus:
RTFDOCvisitor::RTFpost(Word):: …
Kann man das irgendwie schöner darstellen lassen?
Deutsche Umlaute sehen kryptisch aus. Gibt es einen anderen Weg als AE,OE,UE statt ÄÖÜ zu schreiben?
Gibts irgendwo ne dt. Übersetzung der Dokumentation?
Gruß Thomas