DokuWiki

[Powie]

Nach einigen Experiemten.....
.... ja wir machen das über die DokuWiki.
Ich werde Stück für Stück die aktuellen Dokumentationen einarbeiten und erweitern. Wer also Lust hat und sinnvolles beitragen kann ist gern willkommen  /uploads/emoticons/icon_e_wink.gif.c059000ae48ff64afa53be0962c021f2.gif\" alt=\":wink:\" />

[Powie]

2 Admins mehr /uploads/emoticons/icon_e_smile.gif.4a0acefcb917340d2c82e5239c009e6e.gif\" alt=\":)\" />

[rebel]

wer ist denn der zweite?

[Powie]

grml......... Die Doku mit einzelnen Dokumenten ist ätzend, und die Dokuwiki funktioniert unter php5 nicht richtig.......
Welche Varianten gibt es noch die auch php Highlighting unterstützen?

[mahe]

Du könntest pArt ein wenig umarbeiten /uploads/emoticons/icon_e_wink.gif.3167d127940f44558fbf1ccd9b6d60a9.gif\" alt=\";-)\" />
Eine Kategorie Dokumentation und dort dürfen angemeldete User die Artikel bearbeiten.
Allerdings gibts dann keine History...

[k00ni]

Und die Software von Wikipedia, MediaWiki, ist wo nicht so toll? Würde mir jetzt noch als Wiki einfallen. Aber ich denke, da gibt es bestimmt noch andere Wikis.
Meiner Meinung nach ist es nicht wichtig, alles bei dir hier zu dokumentieren. Es stimmt, dass dies vieles beim Entwickeln erleichtert, aber dass machst ja fast allein; ich hab dazu auch nicht immer Lust /uploads/emoticons/icon_e_wink.gif.3167d127940f44558fbf1ccd9b6d60a9.gif\" alt=\";-)\" /> Gut wäre es, wenn du erstmal nur das Wichtigste irgendwo, und da ist die Art und Weise egal, hinschreibst und wenn es geht auch im Code hinterlegst.
Ich selbst bin ja vom Visual Studio .NET sehr begeistert gewesen, als ich die Inline-Dokumentation gesehen habe. Dort wird im Code direkt per XML eine Funktion oder was man möchte, dokumentiert.
Hier ein Beispiel (Aus einem Tutorial für AntMe!):
 

/// 
/// Bestimmt den Typ einer neu zu erzeugenden Ameise.
/// 
/// Anzahl der vorhandenen Ameisen pro Typ
/// Name des Typs
public static string BestimmeTyp(Dictionary anzahl) 
{
return \"\";
}

 
 
Vielleicht hilft das beim Entscheiden.
 
Grüße

[otti_mania]

Warum schreibt ihr keine Dokumentation für entwickler in den Code direkt!
also so ungefähr
// Was macht die funktion?
// Wo ist sie?
// Wohin übergibt sie?
Und was nochso wichtig ist?
ne User Wiki könnte mann ja aufbaun das finde ich würde sinn machen aber für entwickler?
Ich weis nicht

Wie wäre es mit phpDocumentator?  Inline-Doku mit der Möglichkeit, PHP-Manual-artige Dokumentation zu generieren?

[Powie]

für die Dev Doku wäre das was. Für die User Doku allerdings ehr weniger....  Da wohl doch ehr ein PDF /uploads/emoticons/icon_e_smile.gif.4a0acefcb917340d2c82e5239c009e6e.gif\" alt=\":)\" />

[k00ni]

Das wird zu riesig oder? Ich meine, es würde ja schon das eine oder andere Kommentar reichen. Man muss bedenken, dass dies auch jemand pflegen muss und dass dies leider bisher nur der Powie macht. Also ich hätte als Entwickler nichts dagegen, im Gegenteil. Nur sollte man auch realistisch sein. Meiner Meinung nach würde eine konsequente Durchdokumentierung des Codes + ein, zwei erklärende PDF-Seiten für den Anfang ein guter Schritt sein.
 
Grüße

Das wird zu riesig oder?[/quote]
Die PHPDoc-Kommentare halten sich in Grenzen. Üblicherweise ersetzen diese dann sowieso andere Kommentare.

Meiner Meinung nach würde eine konsequente Durchdokumentierung des Codes + ein, zwei erklärende PDF-Seiten für den Anfang ein guter Schritt sein.[/quote]
Was genau an PSys sollte denn ein User ändern wollen, was dann zwei Din-A4-Seiten Doku rechtfertigen sollte? IMHO ist es doch so, dass der User nur ein paar Daten angeben braucht um PSys zum Laufen zu bringen.
Ich finde API-Doku wesentlich wichtiger.

[k00ni]

Was genau an PSys sollte denn ein User ändern wollen, was dann zwei Din-A4-Seiten Doku rechtfertigen sollte? IMHO ist es doch so, dass der User nur ein paar Daten angeben braucht um PSys zum Laufen zu bringen.
Ich finde API-Doku wesentlich wichtiger.
[/quote]
Ja, ich auch. Das mit den PDF-Seiten war auch eher auf Entwickler bezogen und nicht auf User. Ich denke, man sollte hier auch nicht so stark die Usr bedienen, da diese das Forum haben. Und zudem gibt es auch da schon gute Anleitungen, soweit ich mich erinnern kann. Also da erstmal ausreichend.
Und so eine richtige API haben wir ja nicht /uploads/emoticons/icon_e_wink.gif.3167d127940f44558fbf1ccd9b6d60a9.gif\" alt=\";-)\" /> Ein paar Funktionen und da mal eine Klasse. Ich lasse mich betreffend des PHPDoc gerne eines besseren belehren und würde ggf. auch unseren Code schrittweise dafür umstellen. Aber bis dahin...  /uploads/emoticons/icon_e_surprised.gif.a8707b3f35a569cb4cfe563fc72ef78d.gif\" alt=\":-o\" />
 
Grüße

Und so eine richtige API haben wir ja nicht [/quote]
Der PSys-Code steckt voller APIs - leider sehr spezialisiert und teilweise redundant. Jede Funktion beispielsweise stellt ein klassisches funktionsbasiertes API da.

Ein paar Funktionen und da mal eine Klasse.[/quote]
Gerade wenn es keine Abstraktion gibt ist Doku sehr wichtig.

Ich lasse mich betreffend des PHPDoc gerne eines besseren belehren und würde ggf. auch unseren Code schrittweise dafür umstellen.[/quote]
Der Aufwand ist vergleichsweise gering. Die Definitionen im Quelltext sind sehr einfach gehalten; den http://pear.php.net/package/PhpDocumentor/docs/1.4.0/\" rel=\"external nofollow\">PHPDocumentor  gibt es als einfaches PEAR-Package.

[otti_mania]

ich weis nicht aber wenn ihr euch geeinigt habt mit was ihr ne Doku machen wollt dann legt mal alle los
Ich möchte damit sagen alle nicht nur Powie!
ich persönlich würde mich bereit dazu erklären ein ACP-Manual und eine USER-Manual zu schreiben!
weil ich eher davon ausgehe das es Anwender geben wird die nicht alles auf anhieb verstehen!

[Powie]

die Idee von mahe gefällt mir immer besser