Programmtexte in MS Office
-
Hallo,
ich starte gerade ein neues Java-Projekt und möchte die Dokumentation mit MS Office schreiben. Da ich so etwas noch nicht oft gemacht habe, bin ich nicht sicher wie man die Code-Schnipsel am besten formatieren sollte (mit/ohne Zeilennummern, Schriftart, Schriftgröße, Syntax-HL, Einrückung, ...).
Gibt es da Richtlinien?
-
In der Regel ohne Syntax-Highlighting und ohne Zeilennummern. Und auf jeden Fall eine monospace Schriftart (Alle Zeichen gleich breit).
So machen es auch sogut wie alle Fachbücher.
Schriftgröße solltest du so lassen, wie sie auch bei dem vorherigen Text ist. Den gesamten Block kannst du ruhig etwas einrücken, ist aber nicht notwendig. Evtl ganz sanft grau farblich hinterlegen.
-
snOOfy schrieb:
möchte die Dokumentation mit MS Office schreiben
Musste ich einmal machen, kann ich nicht weiterempfehlen.
Meistens ist latex da viel zeitsparender. oder eben direkt javadoc.
-
Courier New + Größe 8-10
-
Aus Eclipse reinkopieren funktioniert auch sehr schön mit Syntax-Coloring. Warum aber nicht Code direkt am Code (sprich Javadoc) dokumentieren?
MfG SideWinder