Alphatester für Dokumentationssystem

[igel457]

Danke für das Lob und die guten Vorschläge, ich schaue mal wie ich das umsetzten kann.

Momentan versuche ich den nun doch ca. 1200 Zeilen langen PHP-Code von einer auf mehrere Include-Dateien aufzuspalten und meine Klassen ein wenig mehr auf das MVC-Schema umzubauen um den Code so flexibel wie möglich zu haben, damit ich Teile später wieder verwerten kann (die erstaunlich gut und flott funktionierende Suche z.B.) und der Sourcecode für andere nützlich ist.

Für weitere Vorschläge/Probleme bin ich natürlich weiterhin offen,
Andreas

[s.h.a.r.k]

Guten Abend,

alles in allem finde ich es sehr gut wo kann man das runterladen? ja, ich weiß, es gibts noch nicht...

ABER
- die 2-3px Farbleisten links sind eher suboptimal für das Verständnis. Du könntest hier die Description in einen Kasten einbauen (sehr dezentes grau mit 1px Rahmen). Die Überschriften stehen ja schon für sich selbst und benötigen an sich keinerlei Farbe. Sollte der Text aber mal so lang sein, dass keine Überschrift zu sehen ist, so benötigt der User aber immerhin eine Legende, welche Farbe der Leiste nun was bedeutet. Daher sind diese eigentlich überflüssig.
- Zum Theme Legende noch was: welche Farbe bei den Methoden steht für welche Eigenschaft?! -> Legende hinzufügen ganz unten oder rechts von der Überschrift (Functions) wäre diese ganz passend.
- Functions (und Proceduren) heißen in Klassen eigentlich Methoden, oder?
- Verlinkung unter Class Tree Visualisation.

[idefix2]

Hallo,

finde ich wirklich sehr gelungen. Optisch 1a.

Das einzige, was mir auf Anhieb aufgefallen ist, was ich ändern würde: in der Class tree visualization sollten die Pfeile doch eher in die andere Richtung zeigen, vom Vorfahr zur abgeleiteten Klasse?

[xZise]

Moin,
dieses grüne Rechteck, könnte man da nicht so Infos unterbringen. Also bei Properties zum Beispiel ob sie beschreibbar sind oder nicht? Außerdem sieht das ein bisschen komisch aus. Einmal steht bei den Properties die ganze Zeile drin und dann schön formatiert, aber dann steht bei den Functions der Code nicht formatiert drin.

Und irgendwie sieht das mit den doppelten Namen bei den Eigenschaften komisch aus.

MfG
Fabian

[Valle]

Hallo,

Zitat von idefix2:

Das einzige, was mir auf Anhieb aufgefallen ist, was ich ändern würde: in der Class tree visualization sollten die Pfeile doch eher in die andere Richtung zeigen, vom Vorfahr zur abgeleiteten Klasse?

In UML ist es üblich, die Pfeile für eine Vererbung in Richtung des Parents zeigen zu lassen.

Liebe Grüße,
Valle

[igel457]

Danke für die Beiträge, das ist ganau das Feedback, das ich mir gewünscht habe. Ich schaue was sich machen lässt.

[xZise]

Moin,
ich weiß nicht ob es im Bereich des möglichen ist, aber ich würde bei dieser Grafik vielleicht das nicht so Spaghettisalat mäßig machen.

Außerdem wäre das praktisch, wenn man die Properties auch dokumentieren könnte (also was macht die property nicht ob sie existiert).

MfG
Fabian

[igel457]

Hi,

Zitat von xZise:

ich weiß nicht ob es im Bereich des möglichen ist, aber ich würde bei dieser Grafik vielleicht das nicht so Spaghettisalat mäßig machen.

Die Grafik wurde von Graphiviz eigentlich schon hochoptimiert, wenn das so kreuz- und quer aussieht ist das eher ein Hinweis auf schlechte Strukturierung des Sourcecodes. Eine bessere Idee habe ich hier nicht.
Da Au3DAudio aber die Top-Level-Unit schlechthin ist, ist das vielleicht nicht weiter verwunderlich...

Zitat von xZise:

Außerdem wäre das praktisch, wenn man die Properties auch dokumentieren könnte (also was macht die property nicht ob sie existiert).

Kann man - ich habe nur noch nicht überall alles dokumentiert:
http://andorracommons.sourceforge.ne...AdDraw#DllName

Trotzdem Danke für die Hinweise!
Andreas

[xZise]

Moin,
achso okay, hatte mich gewundert, weil ich keine Property anklicken konnte, aber die Methodennamen.

MfG
Fabian

[igel457]

So, ich bin mit meinem "Refactoring" auf der PHP Seite jetzt fertig, wenn alles glatt gelaufen ist, hat sich nach außen hin nichts geändert.

Ich habe den PHP-Quelltext mal angehängt, vielleicht kann irgendein PHP-Profi hier mal drüber schauen und seinen Senf dazu abgeben.