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

PHP Grundkurs 1: echo Ausgabe

30. April 2010 in Grundkurs, PHP von Leo

Hallo, dies ist der erste Teil meiner PHP Grundkurs Reihe. Hier zeige ich euch PHP und erkläre euch einiges, damit auch ihr diese Web Programmiersprache erlernen könnt. Anbei möchte ich noch anmerken, dass auch ich erst PHP lerne und die Sprache somit auch noch nicht super beherrsche, aber ich bin dran. Und hier in diesen kleinen Kursen zeige ich euch jetzt, was ich bisher so gelernt habe.

Das erste was man in PHP lernen sollte, was auch sehr simpel ist, jedoch immer benötigt ist, ist die einfache Ausgabe mit ‘echo’.

Zu erst erstellt ihr ein PHP File mit der Dateiendung “.php”. Damit der PHP Code als PHP Code gesehen wird (man kann PHP ja auch in HTML verwenden, dazu aber später noch mehr), muss er in den, ich nenne sie mal PHP Tags stehen. Diese sehen wie folgt aus:

<?php

// Kommentar

?>

Wenn ihr ein anständiges Programm wie Aptana, Notepad++ etc. habt, dann wird euch dieses alles “färben” (Code Highlighting), mehr zu den richtigen Programmen und eine kurze Erklärung folgt noch in einem weiteren Artikel.

Doch zurück zur ‘echo’ Ausgabe. Eine einfache Textausgabe macht ihr nun so:

<?php

echo "Hello World";

?>

Der Syntax ist sehr einfach. Zuerst ‘echo’ dann die Ausgabe in Anführungszeichen und danach, wie in PHP halt üblich, ein Semikolon ‘;’.
Wer das ganze noch mit HTML Code erweitern will, also direkt in der Ausgabe drin, der nutzt die ”:

<?php

echo '<u>Unterstrichen</u><br/>';

?>

Die Ausgabe wäre nun Unterstrichen und nach dem Text folgt ein ‘br’ (break), also ein Zeilenumbruch.

Wer die Ausgabe mehrmals ausgeben will, kann das ganze nun in einer Variable abspeichern, so muss der Text nicht immer neu geschrieben werden. Um dies zu tun, muss der Text in einer Variable gespeichert werden, also die Variable zuerst definiert werden.
Dies geht folgendermassen:

<?php

$hallo = 'Hallo!';

echo $hallo;

?>

In der Variable ‘$hallo’ (Variablen immer mit einem $-Dollar Zeichen am Anfang!) wird also der Text ‘Hallo!’ gespeichert. Im echo wird danach die Variable ausgegeben, also der gespeicherte Wert (‘Hallo!’) in der Variable. Beim Ausgeben einer Variable werden keine Anführungszeichen im echo benötigt, sondern lediglich das $-Dollar Zeichen welches immer vor den Variablen ist.
Würde man im echo die Variable $hallo mit Anführungszeichen ausgeben wollen, würde uns das echo keine Variable, sondern einfach den genauen Text, also ‘$hallo’ ausgeben, was wir ja nicht wollen.

Mehrere Variablen am Stück

Wer nun mehrere Variablen an einer Kette ausgeben möchte, oder auch z.B. eine Variable und einen normalen Text in Anführungszeichen, kann dies so tun:

<?php

$hallo = 'Hallo';
$welt = 'Welt';

echo $hallo . $welt;

?>

Das ganze aneinander hängen geschieht wie ihr oben seht, mithilfe eines Punktes ‘.’
Im Code oben würde die Ausgabe aber HalloWelt heissen, ohne einen Abstand zwischen den beiden Wörtern. Um dies schön zu lösen, hängt mein einfach ein Leerzeichen dazwischen:

<?php

$hallo = 'Hallo';
$welt = 'Welt';

echo $hallo . ' ' . $welt;

?>

Nun ist die Ausgabe schön dargestellt.

Das war Teil 1, Teil 2 folgt demnächst.

Firefox: ICQ Search entfernen

in Software, Tutorials von Leo

Wer hatte das noch nie: Da installiert man ein Programm, klickt immer schön auf den “Weiter”-Button um fortzufahren und merkt dann beim nächsten Firefox Start, dass neben dem Programm auch noch einige andere Änderungen vorgenommen wurde – ich rede von der wirklich nervigen ICQ Search. Die ICQ Search wird bei der Installation von ICQ (und womöglich auch einer Hand voll anderer Programmen) mit installiert, wenn man nicht genau aufpasst, nämlich ist das entfernen eines Häckchen nötig, wenn man gefragt wird ob man die ICQ Search bzw. ICQ Toolbar mit installieren möchte.

Wer die Toolbar oder Search installiert hat, dem wurde die Standard Google-Suche in Firefox mit der nervigen ICQ Search ersetzt. Um diese wieder zu entfernen und alles wieder auf die Standardwerte zu setzen geht ihr folgendermassen vor:

1. Checkt zu erst in der Systemsteuerung unter Programme (Software) deinstallieren ob eventuell auch gleich noch andere Programme statt nur Plugins oder Änderungen installiert wurden. Entfernt diese falls vorhanden.

2. Öffnet nun Firefox und tippt die die Adresszeile folgenden Text ein und drückt Enter:

about:config

Bestätigt danach das ihr Aufpassen werdet.

3. Sucht nun in der config Übersicht oben im Suchfeld nach keyword.URL. Nun stosst ihr auf einen Wert in welchem anstatt Google etwas mit ICQ steht. Einfach über Rechtsklick auf den Standardwert zurücksetzen.

4. Sucht nun noch nach browser.search.defaultenginename und setzt auch diesen Wert auf den Standardwert zurück. Dieser Wert bezieht sich auf das kleine Suchfeld oben rechts im Browser.

Nun wurde hoffentlich alles entfernt. Startet am besten den Browser neu, falls die Änderungen erst nach einem Neustart in Kraft treten sollten.

Erstellen von grösseren Emoticons in MSN

5. November 2009 in Allgemein, Internet, Software von Leo

Wer sich ein schönes Emoticon, also ein Smiley für MSN erstellt hat, oder eins importieren will, nervt sich wahrscheinlich darüber, dass die maximal grösse nur bei 19 x 19px liegt. Jedoch gibt es einen einfachen Trick um grössere Emoticons zu erstellen, die bis zu 40 x 40px gross sein können. Um dies zu erledigen müsst ihr wie folgt vorgehen. Nehmt euer Smiley und speichert es ins .gif Format ab. Das Smiley sollte jedoch nicht all zu gross sein (50 x 50px reichen). Nun müsst ihr euch das Programm “Microsoft GIF Animator” herunterladen (Link am ende des Artikels). Wenn ihr nun euer .gif habt, importiert ihr es in den GIF Animator (hineinziehen geht am schnellsten). Kopiert es 2 mal hinein, und macht danach im Tab “Animation” ein Häckchen unter “Looping” und “Repeat forever”. Nun wird MSN eine Animation vorgetäuscht, welche eigentlich aus den selben Bildern besteht und sie nie verändert. Nun könnt ihr das Smiley ganz normal in MSN Hinzufügen, und euch über das echt grosse Smiley freuen. Das einzig nervige ist hierbei jedoch, dass GIF nicht gerade des schönste Bildformat ist :-)