Aussehen PHP-Dokumentation

Tobse · 27.06.2011, 23:13

Hallo an alle,
ich habe mich in letzter Zeit an einen automatischen PHP-Code Dokumentator gemacht (ja, ich weiss über phpdocumentor).
Uhrsprünglich hatte ich geplant, das Layout und design der PHP-Dokumentation zu übernehmen, das geht aber aus rechtlichen gründen nicht und auf meine E-Mail erhalte ich keine Antwort.
Deshalb muss ein eigenes Design und Layout her. Da ich vermute, gerade in foren wie diesem, später eine große Zielgruppe zu haben, bitte ich hiermit darum, Designvorschläge hervorzubringen, da ich relativ ideenlos bin.

Ihr könnte also eure Vorstellung von der prefekten Doku (zumindest vom aussehen her) hier einsenden und wenn ich es für gut befinde werde ich es übernehmen und in die Software einbauen.

Ich habe hier als Anhang einen Screenshot vom aktuellen Design, falls jemand dau noch etwas äusern möchte.

Also, ich hoffe also auf viele Ideen und Anregungen um am ende eine Software beritstellen zu könne, die jedem nutzer dieses Forums zurechtkommt und bestmöglich die nötigen Ansprüche erfüllt.

Gruß, Tobse

P.S.: Ich habe bereits von anfang an ein Template-System eingebaut, evtl. kann ich betas zum testen herausgeben.

EDIT: Da ich gearade sehe, dass das hier hochgeladene bild... schlecht ist, hier von einem Imagehoster:
http://i55.tinypic.com/2qlv12w.jpg

mn_ · 27.06.2011, 23:30

erinnert iwie an php.net

ich würde als erstes mal den "3d" border bei den tabellen mit einem normalen ersetzen. ich finde der passt überhaupt nicht zum rest

gruß

mermshaus · 27.06.2011, 23:45

Zitat:

Zitat von Tobse

Ihr könnte also eure Vorstellung von der prefekten Doku (zumindest vom aussehen her) hier einsenden und wenn ich es für gut befinde werde ich es übernehmen und in die Software einbauen.

Du scheinst die richtigen Prioritäten zu haben.

Edit: Also, Aussehen ist mir persönlich total egal, solange das inhaltlich/funktional stimmt und nicht gerade quietschgelb ist.

tr0y · 28.06.2011, 02:05

Manpages-Style > all

Tobse · 28.06.2011, 10:38

Zitat:

Zitat von mn_

ich würde als erstes mal den "3d" border bei den tabellen mit einem normalen ersetzen. ich finde der passt überhaupt nicht zum rest

Porbier ich heuit auf jeden Fall mal aus, evtl fällt mir noch ne andere Form für den Border ein. Weil ein einfaches 1px solid #000 oder 1px solid #2A2A2A sieht total komisch aus.

Zitat:

Zitat von mermshaus

Du scheinst die richtigen Prioritäten zu haben.

Edit: Also, Aussehen ist mir persönlich total egal, solange das inhaltlich/funktional stimmt und nicht gerade quietschgelb ist.

Hehe

Mir gehts eher drum eine gute Lesbarkeit herzustellen. Doku lesen ist ja nicht gerade das, was man gerne macht, aber es muss ja sein. Und wenn, dann sollte das schon gemütlich und ohne Augenkrebsrisiko ablaufen

mquadrat · 28.06.2011, 10:57

3D Border muss weg

Da muss ich immer an Geocities denken, wenn ich sowas seh.

Allgemein:
- Zusammenfassung obendrüber und dann Methoden...
- Suche ist arg klein
- Schrift nach Möglichkeit nicht vollschwarz (erkenne ich bei der Sonne grad nicht)

Als Vorlage könntest du dir die .NET Doku mal anschauen. Die ist optisch ganz brauchbar.

Tobse · 28.06.2011, 15:35

Ok, die 3D Border kommt weg xD

Zitat:

Zitat von mquadrat

- Zusammenfassung obendrüber und dann Methoden...

Wie meinst du das? Die Methoden zusammenfassung über die Methodenausführung oder eine generell überschift, also

Code:

Zusammenfassung
 Methoden
  Tabelle
 Varaiblen
  Tabelle
...

Zitat:

Zitat von mquadrat

- Suche ist arg klein

Ja, die is noch aus dem PHP-Layout, dass ich ja nicht benutzen darf, den Header pass ich dann mit ner größeren suche an.

Zitat:

Zitat von mquadrat

- Schrift nach Möglichkeit nicht vollschwarz (erkenne ich bei der Sonne grad nicht)

Ok, ich baus mal ein.

Zitat:

Zitat von mquadrat

Als Vorlage könntest du dir die .NET Doku mal anschauen. Die ist optisch ganz brauchbar.

Gibts da ne Doku? Ich hab die vergebens gesucht und C# dann aufgegeben xD. Dann google ich nochma

tr0y · 28.06.2011, 16:04

http://msdn.microsoft.com/en-us/library/hfa3fa08.aspx

das da ?

mquadrat · 28.06.2011, 17:55

Jep, das da.

Hier mal für ne Klassehttp://msdn.microsoft.com/en-us/libr...generator.aspx

Bei .NET hat man halt immer das Problem, dass es die gleiche Klasse in x .NET Framework Versionen gibt und die Beispiele in y Klassen. Dafür ist es eigentlich nicht schlecht gelöst. Und die Icons sind durchgängig. Sprich in Visual Studio werden die gleichen verwendet. Entfällt bei PHP natürlich

nikosch · 28.06.2011, 18:37

Joah, ist halbwegs anständig. Auf Symboleraten könnte ich allerdings verzichten und die Bezeichner für Sichtbarkeiten, static etc. würden mir als Entwickler mehr zusagen. Vielleicht noch sinnvoll sortiert usw.

Zitat:

Und die Icons sind durchgängig. Sprich in Visual Studio werden die gleichen verwendet. Entfällt bei PHP natürlich

Man könnte ja bspw. Netbeans' Icons nutzen. Allerdings siehe oben.

Themen-Optionen
Druckbare Version zeigen Jemanden per E-Mail auf dieses Thema hinweisen
Thema bewerten
Thema bewerten:

Ähnliche Themen
Thema	Autor	Forum	Antworten	Letzter Beitrag
"Normales" Aussehen eines Debugger-Logs?	Die Webwurst	PHP Einsteiger	3	01.12.2010 16:57
Aussehen von Tabelle (SQL -> PHP) ändern	soulfly	PHP Tipps 2009	13	13.10.2009 16:03
[Erledigt] &amp;amp;amp;quot;DocType XHTML Strict&amp;amp;amp;quot; (Dokumentation?)	Patrick Schwarz	HTML, Usability und Barrierefreiheit	4	04.09.2009 21:00
php_svn - Dokumentation?	freq.9	PHP Tipps 2006	2	27.06.2006 20:12
Platz halter Dokumentation?	b++	PHP Tipps 2006	5	20.03.2006 08:33
Dokumentation von Code	ChewyF5	PHP-Fortgeschrittene	7	09.08.2005 14:28
&quot;DocType XHTML Strict&quot; (Dokumentation?)	Patrick Schwarz	HTML, Usability und Barrierefreiheit	0	05.08.2005 10:56
Wie kann Teamarbeit in einem Flash-Projekt aussehen?	El Barto	Off-Topic Diskussionen	4	04.07.2005 10:27
Dokumentation Datentypen PHPMyAdmin	Lia	PHP Tipps 2005	3	14.04.2005 15:02
wie soll meine SQL - tabelle aussehen?		Datenbanken	5	20.01.2005 23:21
[Erledigt] Wie muss nun meine Abfrage aussehen ?		PHP Tipps 2004-2	2	07.12.2004 15:29
Dokumentation GDLIB in Deutsch		PHP Tipps 2004-2	2	19.11.2004 16:45
Suche Dokumentation ?		PHP Tipps 2004	2	25.10.2004 09:38
Dokumentation von Klassen-Methoden	brain_overload	PHP-Fortgeschrittene	3	07.10.2004 14:08
Dokumentation von PHP-Code	inu	PHP Tipps 2004	4	02.09.2004 13:28

27.06.2011, 23:13
Tobse Neuer Benutzer Registriert seit: 21.11.2010 Beiträge: 16 PHP-Kenntnisse: Fortgeschritten	Aussehen PHP-Dokumentation Hallo an alle, ich habe mich in letzter Zeit an einen automatischen PHP-Code Dokumentator gemacht (ja, ich weiss über phpdocumentor). Uhrsprünglich hatte ich geplant, das Layout und design der PHP-Dokumentation zu übernehmen, das geht aber aus rechtlichen gründen nicht und auf meine E-Mail erhalte ich keine Antwort. Deshalb muss ein eigenes Design und Layout her. Da ich vermute, gerade in foren wie diesem, später eine große Zielgruppe zu haben, bitte ich hiermit darum, Designvorschläge hervorzubringen, da ich relativ ideenlos bin. Ihr könnte also eure Vorstellung von der prefekten Doku (zumindest vom aussehen her) hier einsenden und wenn ich es für gut befinde werde ich es übernehmen und in die Software einbauen. Ich habe hier als Anhang einen Screenshot vom aktuellen Design, falls jemand dau noch etwas äusern möchte. Also, ich hoffe also auf viele Ideen und Anregungen um am ende eine Software beritstellen zu könne, die jedem nutzer dieses Forums zurechtkommt und bestmöglich die nötigen Ansprüche erfüllt. Gruß, Tobse P.S.: Ich habe bereits von anfang an ein Template-System eingebaut, evtl. kann ich betas zum testen herausgeben. EDIT: Da ich gearade sehe, dass das hier hochgeladene bild... schlecht ist, hier von einem Imagehoster: http://i55.tinypic.com/2qlv12w.jpg Geändert von Tobse (27.06.2011 um 23:17 Uhr). Grund: Neues Bild


Mister Ad PHP Code Flüsterer Registriert seit: 21.08.2005 Beiträge: 4682 PHP-Kenntnisse: Fortgeschritten

27.06.2011, 23:30
mn_ Benutzer Registriert seit: 23.06.2011 Beiträge: 32 PHP-Kenntnisse: Fortgeschritten	erinnert iwie an php.net ich würde als erstes mal den "3d" border bei den tabellen mit einem normalen ersetzen. ich finde der passt überhaupt nicht zum rest gruß __________________ mn-projects.de - Artikel, Tipps und Tricks, Online-Tools rund um das Thema Webentwicklung

28.06.2011, 02:05
tr0y Erfahrener Benutzer Registriert seit: 26.07.2010 Beiträge: 4.865 PHP-Kenntnisse: Fortgeschritten	Manpages-Style > all __________________ Lasse mir ohne Anwendung von Gewalt Dinge schenken, Amazon weiß darüber bald mehr.

28.06.2011, 10:57
mquadrat Erfahrener Benutzer Registriert seit: 02.09.2009 Beiträge: 1.019 PHP-Kenntnisse: Fortgeschritten	3D Border muss weg Da muss ich immer an Geocities denken, wenn ich sowas seh. Allgemein: - Zusammenfassung obendrüber und dann Methoden... - Suche ist arg klein - Schrift nach Möglichkeit nicht vollschwarz (erkenne ich bei der Sonne grad nicht) Als Vorlage könntest du dir die .NET Doku mal anschauen. Die ist optisch ganz brauchbar. __________________ Wir suchen PHP Entwickler (Vollzeit) im Raum Darmstadt / Rhein-Main. Infos via E-Mail mueller@new-frontiers.de

28.06.2011, 16:04
tr0y Erfahrener Benutzer Registriert seit: 26.07.2010 Beiträge: 4.865 PHP-Kenntnisse: Fortgeschritten	http://msdn.microsoft.com/en-us/library/hfa3fa08.aspx das da ? __________________ Lasse mir ohne Anwendung von Gewalt Dinge schenken, Amazon weiß darüber bald mehr.

28.06.2011, 17:55
mquadrat Erfahrener Benutzer Registriert seit: 02.09.2009 Beiträge: 1.019 PHP-Kenntnisse: Fortgeschritten	Jep, das da. Hier mal für ne Klassehttp://msdn.microsoft.com/en-us/libr...generator.aspx Bei .NET hat man halt immer das Problem, dass es die gleiche Klasse in x .NET Framework Versionen gibt und die Beispiele in y Klassen. Dafür ist es eigentlich nicht schlecht gelöst. Und die Icons sind durchgängig. Sprich in Visual Studio werden die gleichen verwendet. Entfällt bei PHP natürlich __________________ Wir suchen PHP Entwickler (Vollzeit) im Raum Darmstadt / Rhein-Main. Infos via E-Mail mueller@new-frontiers.de