Verfügbare Informationen zu "Javadoc"
Qualität des Beitrags: Beteiligte Poster: Björn - KnThrak Forum: PG A4 Forenbeschreibung: Forum zur Projektgruppe A4 07/08 aus dem Unterforum: Allgemeines Antworten: 3 Forum gestartet am: Montag 02.04.2007 Sprache: deutsch Link zum Originaltopic: Javadoc Letzte Antwort: vor 17 Jahren, 8 Tagen, 13 Stunden, 34 Minuten
Alle Beiträge und Antworten zu "Javadoc"
Re: Javadoc
Björn - 12.04.2007, 19:20Javadoc
Die Informationen in den "package.htm"'s sind ja mehr als dürftig.
Allerdings kann man in netbeans, unter build, javadoc aus dem Code generieren (die richtigen Tags hat die alte PG ja glücklicherweise benutzt und einiges kommentiert, aber anscheinend vergessen daraus javadoc zu erstellen, bzw. vergessen dies dem source package beizufügen).
Dann hat man Dokumentation im Stile der jdk-Api von Sun, allerdings fehlt trotzdem zu einigen packages (z.b. overview) die Beschreibung, und netbeans weißt einen auf diverse Fehler hin, dies kann allerdings auch zum Teil daran liegen, dass Ich u.U. nicht alle XML Dateien, bei Erstellung eines Projektes mit existierenden Code importiert habe (z.b. scheinen manche Tags wie link, plainlink etc. nicht definiert zu sein...).
Wir sollten vielleicht gucken, dass wir beim Schreiben/Verändern des (existierenden/neuen) Codes, die richtigen Tags benutzen, dies würde uns einiges an Arbeit bzg. der Dokumentation ersparen.
Re: Javadoc
KnThrak - 16.04.2007, 10:13
Hatte ich mir beim ersten Code-durchsehen auch schon gedacht - so die ersten Modifikation am Code sollten wir recht viel Kommetare "mit aufforsten". Könnte im Nachhinein das Chaos vermeiden :P
Irgendwo war der TODO: "hier kommt noch was hin, keine Ahnung was" - der gefiel mir, den können wir so lassen :D
Re: Javadoc
Björn - 16.04.2007, 18:32
Am Anfang bringt es nicht viel sich durch den ganzen Code durchzuwursteln, die javadoc Dateien sind da viel informativer, denn am Anfang ist der Großteil des Quellcodes eher störend.
Ach so was Ich in der ersten Nachricht vergessen habe: Ihr habt euch alle javadoc Dateien von tripleA erzeugt, oder soll Ich die javadoc Dateien gezippt rumschicken (bzw. uploaden)?
ps. Wenn wir mehr als nur Omega-Automaten implementieren wollen, also z.b. Kellerautomaten müssen wir einiges an den Automaten Methoden ändern, bzw. etwas an der Klassenhierarchie - z.b. es gibt ein Problem wenn man den Schnitt von zwei Kellerautomaten bilden will... Aber das können wir ja alles am Mittwoch besprechen.
Mit folgendem Code, können Sie den Beitrag ganz bequem auf ihrer Homepage verlinken
Weitere Beiträge aus dem Forum PG A4
BOMMERHOLZ II - Themenübersicht - gepostet von Lobo am Mittwoch 19.09.2007
Kripke Control Classfile: - gepostet von Lobo am Montag 11.06.2007
Bommerholz - gepostet von Alina am Dienstag 17.07.2007
Kripke und Co... - gepostet von Lobo am Montag 14.05.2007
Ähnliche Beiträge wie "Javadoc"