AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Delphi-PRAXiS - Lounge Klatsch und Tratsch Alphatester für Dokumentationssystem
Thema durchsuchen
Ansicht
Themen-Optionen

Alphatester für Dokumentationssystem

Ein Thema von igel457 · begonnen am 11. Jul 2010 · letzter Beitrag vom 22. Jul 2010
Antwort Antwort
Seite 2 von 3     12 3      
Benutzerbild von igel457
igel457

Registriert seit: 31. Aug 2005
1.622 Beiträge
 
FreePascal / Lazarus
 
#11

AW: Alphatester für Dokumentationssystem

  Alt 12. Jul 2010, 21:53
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
Andreas
"Sollen sich auch alle schämen, die gedankenlos sich der Wunder der Wissenschaft und Technik bedienen, und nicht mehr davon geistig erfasst haben als die Kuh von der Botanik der Pflanzen, die sie mit Wohlbehagen frisst." - Albert Einstein
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k

Registriert seit: 26. Mai 2004
3.159 Beiträge
 
#12

AW: Alphatester für Dokumentationssystem

  Alt 12. Jul 2010, 23:11
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.
»Remember, the future maintainer is the person you should be writing code for, not the compiler.« (Nick Hodges)
  Mit Zitat antworten Zitat
idefix2

Registriert seit: 17. Mär 2010
Ort: Wien
1.027 Beiträge
 
RAD-Studio 2009 Pro
 
#13

AW: Alphatester für Dokumentationssystem

  Alt 13. Jul 2010, 09:28
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?
  Mit Zitat antworten Zitat
Benutzerbild von xZise
xZise

Registriert seit: 3. Mär 2006
Ort: Waldbronn
4.303 Beiträge
 
Delphi 2009 Professional
 
#14

AW: Alphatester für Dokumentationssystem

  Alt 13. Jul 2010, 11:49
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
Fabian
Eigentlich hat MS Windows ab Vista den Hang zur Selbstzerstörung abgewöhnt – mkinzler
  Mit Zitat antworten Zitat
Benutzerbild von Valle
Valle

Registriert seit: 26. Dez 2005
Ort: Karlsruhe
1.223 Beiträge
 
#15

AW: Alphatester für Dokumentationssystem

  Alt 13. Jul 2010, 12:33
Hallo,

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
Valentin Voigt
BOFH excuse #423: „It's not RFC-822 compliant.“
Mein total langweiliger Blog
  Mit Zitat antworten Zitat
Benutzerbild von igel457
igel457

Registriert seit: 31. Aug 2005
1.622 Beiträge
 
FreePascal / Lazarus
 
#16

AW: Alphatester für Dokumentationssystem

  Alt 13. Jul 2010, 19:35
Danke für die Beiträge, das ist ganau das Feedback, das ich mir gewünscht habe. Ich schaue was sich machen lässt.
Andreas
"Sollen sich auch alle schämen, die gedankenlos sich der Wunder der Wissenschaft und Technik bedienen, und nicht mehr davon geistig erfasst haben als die Kuh von der Botanik der Pflanzen, die sie mit Wohlbehagen frisst." - Albert Einstein
  Mit Zitat antworten Zitat
Benutzerbild von xZise
xZise

Registriert seit: 3. Mär 2006
Ort: Waldbronn
4.303 Beiträge
 
Delphi 2009 Professional
 
#17

AW: Alphatester für Dokumentationssystem

  Alt 14. Jul 2010, 14:29
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
Fabian
Eigentlich hat MS Windows ab Vista den Hang zur Selbstzerstörung abgewöhnt – mkinzler
  Mit Zitat antworten Zitat
Benutzerbild von igel457
igel457

Registriert seit: 31. Aug 2005
1.622 Beiträge
 
FreePascal / Lazarus
 
#18

AW: Alphatester für Dokumentationssystem

  Alt 14. Jul 2010, 14:44
Hi,
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...


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
Andreas
"Sollen sich auch alle schämen, die gedankenlos sich der Wunder der Wissenschaft und Technik bedienen, und nicht mehr davon geistig erfasst haben als die Kuh von der Botanik der Pflanzen, die sie mit Wohlbehagen frisst." - Albert Einstein
  Mit Zitat antworten Zitat
Benutzerbild von xZise
xZise

Registriert seit: 3. Mär 2006
Ort: Waldbronn
4.303 Beiträge
 
Delphi 2009 Professional
 
#19

AW: Alphatester für Dokumentationssystem

  Alt 14. Jul 2010, 14:54
Moin,
achso okay, hatte mich gewundert, weil ich keine Property anklicken konnte, aber die Methodennamen.

MfG
Fabian
Fabian
Eigentlich hat MS Windows ab Vista den Hang zur Selbstzerstörung abgewöhnt – mkinzler
  Mit Zitat antworten Zitat
Benutzerbild von igel457
igel457

Registriert seit: 31. Aug 2005
1.622 Beiträge
 
FreePascal / Lazarus
 
#20

AW: Alphatester für Dokumentationssystem

  Alt 14. Jul 2010, 19:02
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.
Angehängte Dateien
Dateityp: 7z docreader.7z (101,8 KB, 7x aufgerufen)
Andreas
"Sollen sich auch alle schämen, die gedankenlos sich der Wunder der Wissenschaft und Technik bedienen, und nicht mehr davon geistig erfasst haben als die Kuh von der Botanik der Pflanzen, die sie mit Wohlbehagen frisst." - Albert Einstein
  Mit Zitat antworten Zitat
Antwort Antwort
Seite 2 von 3     12 3      


Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 00:18 Uhr.
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz