Doxygen: Dokumentation aus Quellcode generieren

9. August 2010 in Java, PHP, Tutorials von Leo

Heute habe ich mir bei der Arbeit das Programm “Doxygen” angeschaut, welches wir nun nach guten Ergebnissen, wahrscheinlich immer nutzen werden. Doch was ist Doxygen?
Doxygen ist ein Programm welches in C++ geschrieben ist und lokal ausgeführt werden kann, um aus Quellcode Dokumentationen zu erstellen. Das Programm scannt die Dateien welche sich in einem ausgewählten Verzeichnis befinden und listet die Funktionen (etc.) auf und liest die Kommentare zu den Funktionen, welche z.B. eine Beschreibung, einen Autor oder andere beinhalten.

Vor allem für grössere Projekte ist dieses Programm meiner Meinung nach sowieso Pflicht, um die Übersicht auf Funktionen zu behalten und auch schnell nachschlagen zu können, vor allem halt auch als nicht beteiligter oder “Neuling” im Projekt.

Doxygen generiert uns also mit dem “Doxywizard” z.B. mehrere HTML-Dateien, welche wir dann gemütlich auf z.B. unseren Web-Server hochladen können.

Doch Doxygen kann nicht nur für PHP Projekte verwendet werden, nein, Doxygen verwendet viele verschiedene Programmiersprachen. Die aktuell Unterstützten Sprachen sind folgende: C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP und C#.

Um Doxygen richtig verwenden zu können, muss der eigene Code Kommentiert werden (am besten in englisch). Dies sieht dann z.B. so aus:

/**
* Beschreibung
*
* @author Max Mustermann
* @since Version 1.0
*
* @param string $string1 beschreibung
* @param bool $string2 beschreibung
* @return string beschreibung
*/
function something($string1, $string2) {
  return $stringX
}

All das wird dann von Doxygen gelesen und so ins Resultat, also die Dokumentation eingefügt.

Hier könnt ihr euch Doxygen herunterladen.

Als Beispiel für so eine Dokumentation, hier unsere öffentliche 4eyes API: www.api.4eyes.ch

Java RPG: Dragonjia

17. Juni 2010 in Java von Leo

In der Schule haben wir vor kurzem eine Arbeit Abgeschlossen, bei welcher jeder Schüler sein eigenes Java Projekt Programmieren musste. Dies konnte entweder ein Spiel sein oder ein Tool wie z.B. ein Taschenrechner. Das ganze musste jedoch mindestens 250 Zeilen Code haben, was ich mit meinen fast 500 Zeilen locker erreichte. Neben dieser Anforderung gab es natürlich noch die Anforderung Sachen zu Verwenden die wir im ersten Jahr nun gelernt hatten, sowie musste man seinen Quellcode 100%ig verstehen, was mir auch keine Mühe machte da ich alles komplett selber geschrieben habe.

Für mein Spiel gab es schlussendlich eine 5.5, also gar nicht mal schlecht ;) Ich habe mich aber entschieden wenn ich mal Zeit und Lust habe noch etwas weiter am Spiel zu Programmieren, da ich noch mehr draus machen möchte, denn leider reichte die Zeit bis zum Abgabetermin nicht aus etwas grösseres zu machen, da meine Idee schon sehr Umfangreich war.

Das Spiel werde ich übrigens noch nicht veröffentlichen, da es noch lange nicht Fertig ist und wahrscheinlich den meisten kaum Spass machen würde ;)

Wie auch immer… hier werde ich euch natürlich, falls es neuigkeiten gibt, davon Berichten. Sobald der Zeitpunkt gekommen ist werde ich es dann auch mal veröffentlichen.

Noch eine Anmerkung: Das Spiel ist ein Text basiertes Spiel, also nichts mit 3D und so :P

Java Programmieren Lernen mit MSN

7. Oktober 2009 in Java von Leo

Ja, auch dies ist möglich. Zwar nicht mit MSN direkt, sondern eher mit dem MSN Addon “MSN Plus!”. Für dieses kann man nämlich eigene Skripte erstellen, welche man dann in MSN benutzen kann. Für den Anfang kann man kleinere Skripte programmieren wie “Random Jokes” oder ähnliches. Das ganze wird in “.js” und “.xml” Dateien geschrieben. Das Hauptprogramm kommt in die “.js” Datei, welche den Namen des Skripts trägt. Dort findet (fast) alles statt. Die Skripts können alle mit Java geschrieben werden, der Vorteil ist dabei, dass auch ein Anfänger schnell die ersten Tricks raus hat und gerade bei MSN Plus Skripten schnell ein Resultat sieht. Natürlich bieten die Macher von MSN Plus eine Hilfe für Entwickler, so könnt ihr auf der offiziellen Seite eine Dokumentation – welche derzeitig leider nur auf englisch verfügbar ist – herunterladen. Diese erklärt euch wie alles Funktioniert, und zeigt auch einige Begriffe und Befehle in MSN Plus.