Hinweise für die schriftliche Ausarbeitung von Diplom-, Master

-
Prof. Dr. Ing. Werner Zimmermann
Fakultät Informationstechnik
-
Hinweise für die schriftliche Ausarbeitung von Diplom-, Master- und Studienarbeiten
1. Zweck der schriftlichen Ausarbeitung
Ihre Ausarbeitung wird weder für den Bücherschrank Ihres Professors an der FHTE noch als
Tagebuch für Ihren Nachttisch geschrieben, sondern für
-
einen anderen Studenten, der an Ihrer Arbeit weiterarbeiten soll oder für
einen Ingenieur, der das Produkt Ihrer Arbeit einsetzt, dabei auf ein Problem stößt und
dies schnellstmöglich lösen will.
Bei dem Studenten dürfen Sie von denselben Vorkenntnissen ausgehen, die Sie hatten, als
Sie die Arbeit begonnen haben. Sie sollten ihm aber dieselbe Mühe und dieselben Probleme ersparen, die Sie während Ihrer Einarbeitung in das Thema hatten. Bei dem Ingenieur
müssen Sie davon ausgehen, dass er sich in der Arbeit schnell zurechtfinden will, ohne die
gesamte Arbeit durchzulesen.
Beide Ziele widersprechen sich nicht! Ihre Ausarbeitung sollte kurz und präzise sein (Studienarbeiten: 10-20 Seiten, Diplomarbeiten: 30 - 50 Seiten ohne Schaltpläne und Softwarelistings reichen völlig), mit Bildern kann man technische Sachverhalte meist besser beschreiben als mit vielen Seiten Text. Jeder Abschnitt Ihrer Arbeit sollte so gegliedert sein,
dass man zuerst eine kurze Zusammenfassung und einen Überblick über den Inhalt und das
Ergebnis des Abschnitts erhält, um zu entscheiden, ob man den Rest des Abschnitts überhaupt lesen muss. Ganz besonders wichtig sind dabei die Abschnitte 'Einführung' und 'Zusammenfassung und Ausblick' (s.h. unten).
Realisierung
Beschreibung der Hard- und/oder Softwarerealisierung, in der Regel sollten Hardware- und Softwareteil getrennt beschrieben werden.
Ergebnisse
Messergebnisse, Angaben über Programmgröße und Laufzeiten
SCHLUSS
Zusammenfassung und Ausblick
Zusammenfassung (muss einem eiligen Leser zusammen mit dem Teil Einführung
vollständig erläutern, was in der Arbeit gemacht und welches Ergebnis erzielt
wurde.), die Zusammenfassung soll auch ungelöste Probleme und Schwachstellen
ansprechen sowie Hinweise für Verbesserungs- und Ergänzungsmöglichkeiten
enthalten.
-
ANHANG
- Literaturverzeichnis
- Bedienungsanleitung
- Hardwaredokumentation
- Softwaredokumentation
- Messergebnisse (soweit nicht bereits im Hauptteil behandelt)
3. Nummerierung der Abschnitte
Die Hauptabschnitte (Einführung, Lösungsansatz, ..., Zusammenfassung und Ausblick) werden mit einer Dezimalziffer bezeichnet: Die Untergliederung erfolgt in 3, maximal 4 Stufen:
1.
1.1
1.1.1
(1.1.1.1)
Der Anhang wird mit A.1, A.2, ... durchnumeriert und ggf. ebenfalls untergliedert.
2. Gliederung
EINLEITUNG
Titelblatt
Fachhochschule für Technik Esslingen
Fachbereich Informationstechnik, Studiengang ...
Diplomarbeit
Wintersemester ... bzw. Sommersemester ...
Titel der Arbeit
Name des Verfassers
Betreuer:
Name des Betreuers und der Firma (bei Industriediplomarbeiten)
Name des betreuenden FHTE-Professors
- Danksagung (nur bei Industriearbeiten)
Dank an die Firma und die Firmenmitarbeiter
- Kurzzusammenfassung
Zusammenfassung für das 'Management', max. 1 Seite
- Inhaltsverzeichnis
- Liste der Formelzeichen
- Einführung
Erläuterung der Aufgabenstellung und der Randbedingungen
-
HAUPTTEIL
- Lösungsansatz
Beschreibung des Lösungswegs und ggf. der theoretischen Grundlagen
4. Nummerierung der Bilder
Bilder werden innerhalb eines Hauptabschnitts durchnumeriert, z.B. Bild 1.1, Bild 1.2, .... Jedes Bild erhält eine kurze Bildunterschrift und muss im Text zitiert werden, z.B. 'Wie man in
Bild 3.1 sieht ....' oder ' Die Schaltung (Bild 5.7) ...'. Der Text sollte aber keine Bildbeschreibung sein, d.h. Bilder müssen aus sich heraus verständlich sein, was als Bild dargestellt
wird, muss - bei einem guten Bild - nicht mehr im Text beschrieben werden!
5. Literaturstellen
Bücher und Zeitschriften werden innerhalb des gesamten Textes als [1], [2], ... oder innerhalb eines Hauptabschnitts als [1.1],[1.2],... durchnumeriert und ebenfalls immer im Text zitiert, z.B. '...wie in [1] dargestellt wird...'. Im Literaturverzeichnis steht dann:
- bei Büchern
[1]
Vor- und Zuname des Verfassers: Titel des Buchs. Name des
Verlags; Erscheinungsjahr; (evtl. Nummer des Kapitels)
- bei Zeitschriften
[1]
Vor- und Zuname des Verfassers: Titel des Artikels. Name der
Zeitschrift; Nummer des Hefts (Jahr); Seite ... - ...
Bei Büchern ist es gelegentlich sinnvoll, auch das Kapitel anzugeben, in dem das angesprochene Thema beschrieben wird, damit der Leser nicht das gesamte Buch durchlesen muss.
Grundsätzlich sollte nicht wahllos Literatur angegeben werden. Es sollten nur diejenigen Bücher bzw. Zeitschriften zitiert werden, die Ihr Nachfolger, der an Ihrem Thema weiterarbeiten
soll, benötigt, um sich in das Thema einzulesen bzw. um detailliertere Informationen zu erhalten.
Wenn es Ihnen nicht gelingt, den Inhalt einer Literaturstelle auf einer oder wenigen Seiten
zusammenzufassen, sollten Sie lieber die Literaturstelle zitieren, statt sie abzuschreiben!
Hochschule Esslingen
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 1
DIPLOM.DOC
FHT Esslingen
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 2
DIPLOM.DOC
Das gilt insbesondere für Grundlagenartikel! Die theoretischen Grundlagen für den Abschnitt
'Lösungsansatz' allerdings müssen Sie so darstellen, dass Ihr Nachfolger den Abschnitt
auch versteht, ohne weitere Literaturstellen zu lesen.
6. Formelzeichen
Soweit Sie sich an diese Konventionen halten und keine weiteren Formelzeichen verwenden, kann die 'Liste der Formelzeichen' in Ihrer Arbeit entfallen:
Kleinbuchstaben
=
Augenblickswerte
Großbuchstaben
=
arithmetische Mittelwerte
Großbuchstaben mit Index 'eff'
=
Effektivwerte
unterstrichene Großbuchstaben
=
Zeigerwerte
u
i
t
T
f
ω
s
z
Spannung
Strom
Zeit, Zeitpunkt
Zeitdauer, Periodendauer
Frequenz
Kreisfrequenz
Laplace-Variable
z-Variable
R
C
L
Z
G(s)
Widerstand
Kapazität
Induktivität
komplexe Impedanz
Übertragungsfunktion
Die für die Blöcke und Daten verwendeten Namen sollten gut verständlich sein und sich im
Programmlisting wiederfinden lassen. Das Datenkonzept ist zu erläutern (Stackparameter,
globale Variable etc.), aus dem Datenflussdiagramm muss eindeutig ersichtlich sein, in welchem Programmteil und ggf. wann eine Variable geschrieben und wo bzw. wann sie gelesen
wird. (Dies ist natürlich nicht für Variable oder Konstante notwendig, die nur innerhalb einer
Funktion verwendet werden).
7. Beschreibung einer Hardwarelösung
Schaltungen werden mit Hilfe von Blockschaltbildern beschrieben, beginnend mit einem Gesamtblockschaltbild, das dann schrittweise verfeinert wird. Die Funktion der Blöcke sollte im
Text erläutert werden. Die Ein- und Ausgangssignale der Blöcke sollten mit Namen bezeichnet werden (die Namen sollten verständlich sein und sollten in Messdiagrammen und in den
Schaltplänen durchgängig verwendet werden!). Insbesondere bei digitalen Schaltungen sind
zusätzliche Zeitdiagramme für die wichtigsten Signale sowie gegebenenfalls Zustandsdiagramme notwendig. Detaillierte Schaltpläne gehören nicht in den Hauptteil, Ausnahmen sind
nur bei besonders pfiffigen bzw. kritischen Schaltungsteilen notwendig. Die im Blockschaltbild dargestellten Blöcke müssen sich im eigentlichen Schaltplan wiederfinden lassen, z.B.
Spannungsversorgung, Vorverstärker etc., ggf. sind die Blöcke im Schaltplan ebenfalls zu
kennzeichnen! Dimensionierungsrechnungen sind nur bei kritischen Schaltungsteilen notwendig, z.B. wenn die Filterzeitkonstante eines Eingangsfilters einen bestimmten Wert haben muss o.ä... In den Anhang gehören
- das Pflichtenheft
- vollständige Schaltpläne (lesbare Schrift, Größe A4 oder A3) (Bauteile im Schaltplan
durchnumeriert, z.B. R1, T3, IC9.., ggf. zusätzlich mit Werteangabe, z.B. R1 1k, T5
BC237B, IC9 L249)
- Stückliste (Nummer des Bauteils im Schaltplan - Wert - bei Kondensatoren: Typ, z.B.
MKS, Tantal o.ä., min.Spannung - bei Exotenbauteilen, z.B. Schaltern, Gehäuse etc.:
Hersteller)
- Bestückungspläne
- Layout (Papierkopie und/oder Filme)
- Konstruktions- und Zusammenbauzeichnung bei Gehäusen
- Prüfvorschrift, Inbetriebnahme- und Nachbauhinweise
- Abgleichvorschrift (falls Abgleiche vorhanden)
- CD-ROM / Diskette mit Schaltplänen und Layouts, Angabe mit welchem Schaltplan /
Layoutprogramm inkl. Versionsnummern gearbeitet wurde. Liste der Dateien mit Angabe, welche Datei was enthält!
FHT Esslingen
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
8. Beschreibung einer Softwarelösung
Die Entwicklung und Beschreibung der Software soll mit Hilfe der Strukturierten Analyse
oder der Objektorientierten Modellierung erfolgen. Die Beschreibungsmittel sind Kontextdiagramme, Datenflussdiagramme, Data-Dictonnary etc.. bzw. die UML-Symbolik. Wird die
Analyse nicht in strenger Form angewendet, so ist ersatzweise die Beschreibung in graphischer Form mit Hilfe eines Programmblockschaltbilds (=Datenflussdiagramm, nicht verwechseln mit einem Programmflussdiagramm!) zulässig, beginnend mit einem Übersichtsblockschaltbild, das schrittweise verfeinert wird. Das Blockschaltbild beschreibt (bei einem
prozeduralen Programm) die einzelnen Funktionen des Programms, die Verbindungen der
Blöcke entsprechen den Ein- und Ausgangsdaten der einzelnen Funktionen (bzw. den in
den Funktionen verwendeten globalen Variablen). Die Aufgaben der einzelnen Blöcke sind
im Text knapp zu erläutern. Das Ende der Verfeinerung ist erreicht, wenn die Funktion eines
Blocks in 1 bis 3 Sätzen beschrieben werden kann.
Die Hierarchie der einzelnen Programmteile ist durch Hierarchie(Aufruf-)diagramme darzustellen. Der zeitliche Ablauf (bei Echtzeitsystemen) ist durch Angabe der 'Abtastzeiten' für
die einzelnen Funktionen (kann in die Blockdiagramme eingetragen werden) sowie durch ein
Ablauf- oder Zustandsdiagramm darzustellen, insbesondere, wenn dynamische Prioritäten,
gegenseitiger Ausschluss o.ä. verwendet werden.
Struktogramme und Programmflussdiagramme sind Hilfsmittel des Programmfeinentwurfs,
für die Beschreibung der Programmstruktur bei komplexeren Programmen sind sie in der
Regel ungeeignet, weil bereits viel zu detailliert. Sie sollten nur in Ausnahmefällen (kritische
Programmteile, trickreiche Lösung) im Hauptteil verwendet werden.
In den Anhang gehören
- das Pflichtenheft
- Struktogramme oder Flussdiagramme, soweit zum Entwurf des Programms verwendet
(und noch korrekt!) oder aus dem Programm z.B. mit X-Tools automatisch generiert; eine nachträgliche Erstellung von Hand ist im allgemeinen sinnlose Zeitvergeudung!
- CD-ROM/Diskette mit dem Sourcecode, einer lauffähigen Version, allen Projekt- und
Makefiles sowie gegebenenfalls verwendeten Toolboxen und Hilfsprogrammen bzw. bei
sehr großen Programmen Angabe, auf welchem Rechner und Verzeichnis die Programmdateien zu finden sind*1
- Übersichtsliste über die Verzeichnisstruktur auf der Diskette (bzw. Festplatte) und alle
Dateien, sowie Angabe, welche Datei was enthält, insbesondere wenn auf der CDROM/Diskette unterschiedliche Versionsstände zu finden sind
- Übersichtsliste über alle verwendeten Compiler, Assembler etc. inklusive deren Versionsstand, Voreinstellungen, Compilerschalter etc.
Das Programmsourcelisting muss enthalten
- Klassenhierarchie (bei objektorientierten Programmen) oder Aufrufhierarchie (bei prozeduralen Programmen)
- Liste aller globalen Variablen und Konstanten inkl. Normierungsvorschriften
- Funktionskopf zu jeder Funktion/Methode mit
- kurzer Funktionsbeschreibung
- Beschreibung der verwendeten globalen Variablen
- RAM/ROM-Bedarf, Laufzeit (bei Mikrocomputer- und Echtzeitprogrammen)
- Name des Autors, Versionsstand, Änderungshistorie
- ausführliche Programmkommentare
Seite 3
FHT Esslingen
DIPLOM.DOC
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 4
DIPLOM.DOC
*1 Die Verwendung von Softwaretools, die (bei Firmenarbeiten) nicht in der Firma bzw. (bei
Hochschularbeiten) nicht im HZE-Rechenzentrum vorhanden sind, ist vor ihrer ersten
Anwendung mit dem Industrie- bzw. Hochschulbetreuer abzusprechen.
9. Bedienungsanleitung
Anleitung für einen Benutzer des Geräts oder Programms, sollte in die Teile
Installation inkl. Betriebssystem, Speicherplatzbedarf, Pfade
Anschlüsse / Verkabelung
'Getting Started' (inkl. erforderliche Voreinstellungen)
Tutorial (Lernprogramm)
Referenzteil
gegliedert sein. Die Anleitung ist für Benutzer gedacht, die nur die Bedienungsanleitung
lesen. Je besser die Benutzerführung des Programms und die - hoffentlich - eingebaute Hilfefunktion ist, umso kürzer kann dieser Teil sein.
10. Seminarvortrag (bei Diplomarbeiten)
In diesem Vortrag sollen Sie innerhalb von 20min anderen Studenten (nicht Ihren Betreuern!) erläutern, welche Problemstellung Sie bearbeitet haben, welchen Lösungsweg Sie gewählt haben und was dabei herausgekommen ist. Denken Sie daran, dass der Zuhörerkreis
dieselben Voraussetzungen und Vorkenntnisse hat wie Sie zu Beginn der Arbeit. Daher ist
eher ein Überblick gefragt, auf Details können Sie allenfalls an einer z.B. besonders trickreichen Stelle eingehen, wenn Sie zuvor die nötigen Erläuterungen gegeben haben.
Versuchen Sie alles mit Folien zu erläutern, dabei sind Bilder besser als Text! Die erste Folie ist immer eine Inhaltsübersicht, die letzte immer eine Zusammenfassung. Legen Sie
Ihrem Betreuer, bevor Sie mit der Feinarbeit beginnen, die Gliederung Ihres Vortrags und
später den Entwurf Ihrer Folien vor. Denken Sie daran, dass jede Folie zwischen 3 und 5
Minuten auf dem Projektor liegen sollte, der Umfang ist also beschränkt.
Bei einer Industriediplomarbeit sind Ihre Industriebetreuer herzlich zu Ihrem Vortrag an der
FHTE eingeladen. Wenn Sie auch in der Industriefirma einen Vortrag halten dürfen, denken
Sie daran, dass Sie dort einen Teilnehmerkreis mit anderen Vorkenntnissen haben, der die
Problemstellung in der Regel sehr viel besser kennt als Ihre Kommilitonen an der FHTE.
Dort dürfen die einführenden Erläuterungen etwas kürzer ausfallen und Sie ruhig etwas
stärker ins Detail gehen.
11. Äußere Form
Loseblattsammlungen, Schmierzettel, unlesbare Kopien, aber auch viele Rechtschreib- oder
Satzzeichenfehler machen die Korrektur Ihrer Arbeit mühsam und führen daher mit Sicherheit zu einer schlechteren Note.
Verwenden Sie ein ordentliches Textverarbeitungsprogramm (z.B. Word, für Hartgesottene
auch LaTex etc.) und einen ordentlichen Drucker (beides steht u.a. im Rechenzentrum und
im Diplomarbeitsraum zur Verfügung). Mit einer konventionellen Schrift (Arial, Times, Letter
Gothic 12 Punkt) erzielen Sie als Amateur bessere Ergebnisse als wenn Sie sich mit dem
'Schnickschnack' eines DTP-Programms versuchen. Zeichnungen können mit einem einfachen CAD-Programm (AutoCad, Designer, CorrelDraw, Microsoft Draw) erstellt werden.
Verwenden Sie beim Ausdrucken von Programmlistings eine Nicht-Proportionalschrift (z.B.
Courier) und kontrollieren Sie, ob die Einrückungen/Tabulatoren korrekt ausgedruckt werden, verwenden Sie eine möglichst kleine Schriftgröße um Zeilenumbrüche zu vermeiden,
die das Listing unlesbar machen!
Das Abgabeexemplar sollte eine gute Fotokopie auf weißem Papier sein, ich bevorzuge
Leitzordner oder Ringbücher. Geben Sie bitte zusätzlich eine CD-ROM ab, auf der Ihre gesamte Dokumentation einschließlich der Anhänge nach Abschnitt 7 und 8 im PDF-Format
(notfalls auch in WORD) und Ihr Diplomandenvortrag ebenfalls im PowerPoint- oder PDFFormat.
Lassen Sie Ihre Arbeit -falls überhaupt- auf keinen Fall binden, bevor ich sie gesehen habe!
12. Terminplan für die Dokumentation
Da die Dokumentation weder bei Ihnen noch bei Ihren Betreuern ‚vom Himmel fällt‘, sollte
Sie in folgenden Schritten erstellt werden:
• Festlegung der Dokumentationswerkzeuge (Textverarbeitung, Zeichenprogramme
etc.) durch den Diplomanden in Absprache mit dem Industriebetreuer → zu Beginn der
Arbeit! Achten Sie darauf, dass die im Lauf der Arbeit mit Software- oder Hardwaretools
erstellten Unterlagen dazu kompatibel sind (z.B. Klassendiagramme von CASE-Werkzeugen, Plots von Messungen etc.).
• Planen Sie für die Dokumentation und den Vortrag die letzten 4 Wochen der Diplomarbeit ein. Zu Beginn dieser Phase sollte der praktische Teil Ihrer Diplomarbeit vollständig abgeschlossen sein! Sie werden sehen, dass Sie diese Zeit unbedingt benötigen.
• Laufende Dokumentation während der Arbeit. Leider gelingt es nur in seltenen Fällen
wirklich, während der Arbeit bereits einzelne Kapitel der Dokumentation in endgültiger
Form zu erstellen. Sie sollten aber unbedingt sämtliche Arbeitsunterlagen (Pflichtenhefte, Gesprächsprotokolle, Konzeptdarstellungen, Entwurfsdiagramme, Messdokumente)
so erstellen, ordnen und mit ausreichend vielen Kommentaren/Notizen versehen, dass
Sie sie am Ende der Arbeit wiederfinden (und immer noch verstehen!).
• Spätestens 6 Wochen vor Abgabe der Arbeit (im Sommersemester Anfang Mai, im
Wintersemester Anfang Dezember) möchte ich eine schriftliche Gliederung Ihrer Dokumentation haben. Die schriftliche Gliederung soll ein mit Stichworten versehenes Inhaltsverzeichnis sein. Umfang ca. 2-4 Seiten. Die Gliederung soll vorher mit dem Industriebetreuer abgestimmt sein.
• Spätestens 4 Wochen vor Abgabe der Arbeit (im Sommersemester Ende Mai, im Wintersemester Mitte Dezember) möchte ich eine Leseprobe haben, d.h. ein beliebiges
Probekapitel im Umfang von 5 bis 10 Seiten, damit ich Ihren Darstellungsstil beurteilen
und Ihnen gegebenenfalls rechtzeitig noch einige Tipps geben kann. Auch die Leseprobe soll vorher mit dem Industriebetreuer abgestimmt sein.
• Abgabe der Arbeit zum vereinbarten Termin, üblicherweise am letzten Vorlesungstag
des Semesters. Geben Sie die endgültige, mit dem Industriebetreuer abgestimmte Arbeit
ab. Die abgegebene Arbeit dient als Grundlage für die Bewertung Ihrer Diplomarbeit!
13. Weitere Erläuterungen
Das Erstellen guter technischer Berichte und das Halten guter Vorträge ist für Ihr Berufsleben sehr wichtig. Ihre Vorgesetzten nehmen in der Regel weniger Ihre gute Arbeit an sich
zur Kenntnis, sondern viel mehr die Art, wie Sie darüber berichten. Es gibt sehr viele Bücher
zu diesem Thema, für technische Diplomarbeiten gut geeignet und nicht allzu teuer ist z.B.:
W.Grieb: Schreibtips für Diplomanden und Doktoranden. VDE-Verlag; 1991
Trotz oder wegen der Textverarbeitung gibt es häufig Rechtschreib- und Tippfehler. Wenn
Sie sich in der Rechtschreibung nicht sicher sind, suchen Sie sich trotz Textverarbeitung mit
integrierter Rechtschreibprüfung einen Korrekturleser. Insbesondere bei der Zeichensetzung
hilft Ihnen der Computer (noch) nicht. Der Besitz und die Benutzung (!) eines Duden ist auch
für einen zukünftigen Dipl.-Ing. keine Schande! Denken Sie übrigens auch daran, dass die
deutsche Sprache die Möglichkeit der Silbentrennung besitzt. Beugen Sie dem 'Flattersatz'
vor, indem Sie Silbentrennungen verwenden, im Zweifel hilft Ihnen wieder Ihre Textverarbeitung.
FHT Esslingen
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 5
FHT Esslingen
DIPLOM.DOC
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 6
DIPLOM.DOC
zusammengesetzten Namen sollten neue Namensteile mit Grossbuchstaben begonnen
werden (nicht durch ‚_‘ abtrennen), z.B. die Variable dateiName.
Anhang: Software-Namensregeln
Wenn keine anderen Codierregeln vorgeschrieben sind, sind folgende Vereinbarungen einzuhalten:
Zeilenlänge, und Schriftart für Editor bzw. Programmlisting
Schriftart: Schrift mit fester Zeichenbreite, z.B. FixedFont, Courier oder Letter Gothic, keine
Proportionalschrift verwenden!
Standardzeilenlänge ist 80 Zeichen, in Ausnahmefällen 120Zeichen, dann aber beim Ausdruck 8pt Schrift verwenden.
Soweit im Editor vorhanden: Farbige Syntaxhervorhebungen verwenden.
Einrückung (Indendation) bei C/C++ und Java-Programmen
• Tabulator-Schrittweite (Tab Spacing) auf 8 Zeichen setzen
• Einrückung (Indendation): 4 Zeichen je Ebene, d.h. die Zeilen beginnen in den Spalten 1,
5, 9, 13, ...
• öffnende ' { ' auf die neue Zeile, erste Deklaration/erster Befehl in dieselbe Zeile dahinter
• schließende ' } ' in einer separaten Zeile, Rest der Zeile leer
Bsp: (Leerzeichen zur Verdeutlichung als '.' markiert
Es sind folgende Datentypen zu verwenden:
char
8bit, signed
short
16bit, signed
int
16bit, signed (bei 16bit Compiler), 32bit signed bei 32bit Compiler
long
32bit, signed
float
32bit real
double
64bit real
typedef unsigned char BYTE
typedef unsigned short WORD
typedef unsigned long DWORD
Java:
Variablennamen:
Klassennamen:
Methodennamen:
Konstantennamen:
niert
in Kleinbuchstaben
1. Zeichen: Grossbuchstabe, Rest Kleinbuchstaben
in Kleinbuchstaben
in Grossbuchstaben, mit 'static final ...' am Anfang einer Klasse defi-
/* Hauptprogramm
Funktion: Wertet die Kommandozeilenparameter aus und ...
*/
void main(int argc, char** argv)
{...int i;
....for (i=0; i < argc; i++)
....{...if (argc==2)
........{...break;
........} else
........{...continue;
........}
....}
}
Mehrzeilige Kommentarblöcke mit /* ... */ beginnen und enden in der ersten Spalte.
Einzeilige Kommentare mit // beginnen alle einheitlich in derselben Spalte, z.B. Spalte 65
(Ausnahme: bei längeren Programmstatements entsprechend weiter hinten)
C/C++:
Variablennamen:
Klassennamen:
in Kleinbuchstaben
sollten mit Präfix c beginnen, nächstes Zeichen als Grossbuchstabe
Rest: Kleinbuchstaben
Pointer:
sollten mit Präfix p beginnen, nächstes Zeichen als Grossbuchstabe,
Rest: Kleinbuchstaben
Funktionen/Methoden:1.Zeichen: Grossbuchstabe, Rest: Kleinbuchstaben
Konstantennamen: in Grossbuchstaben, mit #define am Programmanfang oder in einem
separaten Headerfile definiert
Makros:
wie Konstantennamen
Typennamen:
sollten mit Präfix t beginnen, nächstes Zeichen als Grossbuchstabe,
Rest: Kleinbuchstaben
Variablen und Funktionen erhalten einen 'sprechenden' Namen, d.h. einen Namen, der die
Funktion erläutert. Ausnahme: lokale Zählvariable dürfen mit i, k, ... bezeichnet werden. Bei
FHT Esslingen
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 7
FHT Esslingen
DIPLOM.DOC
V2.0 Dez. 06
Prof. Dr.-Ing. W. Zimmermann
Seite 8
DIPLOM.DOC