Ergebnis 1 bis 7 von 7

Thema: Aussehen PHP-Dokumentation

  1. #1
    Kaiser(in)
    Registriert seit
    29.03.2009
    Ort
    1011 1111 1011 WorldWideWeb
    Beiträge
    2.439
    Danke
    2
    Bekam 6 mal "Danke" in 6 Postings

    Standard 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önnen, 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.

    2qlv12w.jpg
    Achtung: Dies ist ein alter Thread im HTML und Webmaster Forum
    Diese Diskussion ist älter als 90 Tage. Die darin enthaltenen Informationen sind möglicherweise nicht mehr aktuell. Erstelle bitte zu deiner Frage ein neues Thema im Forum !!!!!
    Der, der weiß dass er nichts weiß, weiß mehr als der, der nicht weiß, dass er nichts weiß.
    Wer nach etwas fragt, geht grundsätzlich das Risiko ein, es auch zu bekommen!

  2. #2
    Unregistriert
    Gast

    Standard AW: Aussehen PHP-Dokumentation

    Etwas OT: Du bastelst immer an Sachen, die es schon zu genüge in guter Qualität gibt. Da will doch kein Mensch deine Beta-Versionen haben. Suche dir, auch wenn das schwer wird, ein Projekt aus, bei dem du wirklich Nutzen schaffst und/oder verbessere ein bestehendes, kleines Projekt. Du verbräts da Zeit für Nusskuchen.

  3. #3
    Kaiser(in)
    Themenstarter

    Registriert seit
    29.03.2009
    Ort
    1011 1111 1011 WorldWideWeb
    Beiträge
    2.439
    Danke
    2
    Bekam 6 mal "Danke" in 6 Postings

    Standard AW: Aussehen PHP-Dokumentation

    Ich habe schon länger gegoogelt und habe nur phpdocumentor.org gefunden - auf der suche nach so einem Programm, weil ich selbst eins wollte, dass mit die arbeit abnimmt. Aber die Demo-Seiten auf der Webseite sehen sooo langweilig aus, ich würde glaub keine Dokumentation, die damit erstellt wurde, länger als 10 Minuten lesen. Deshalb wollte ich es besser machen.
    Und ja, ich bastle gerne an dingen, dies evtl. schon gibt - mir ist das aber egal. Es ist eine Heruasforderung, an der ich wachsen kann, Geld verdienen ist eh noch nicht.
    Und zwischen phpdocumentor.org und meinem Prog ist noch ein wesentlicher unterschied. Dazu aber wenns fertig ist.
    EDIT: Das mit dem ausprobieren war eher auf die Templates als auf das ganze bezogen.
    Geändert von Tobse (28.06.2011 um 15:18 Uhr)
    Der, der weiß dass er nichts weiß, weiß mehr als der, der nicht weiß, dass er nichts weiß.
    Wer nach etwas fragt, geht grundsätzlich das Risiko ein, es auch zu bekommen!

  4. #4
    der/die Göttliche Avatar von jojo87
    Registriert seit
    23.03.2007
    Ort
    Leipzig
    Alter
    30
    Beiträge
    3.131
    Danke
    0
    Bekam 0 mal "Danke" in 0 Postings

    Standard AW: Aussehen PHP-Dokumentation

    Warum bastelst du nicht ein schickes Template für PHPDoc?
    Ohne dich beleidigen zu wollen denke ich nicht, dass du eine Software ähnlicher Qualität hinbekommst.
    Und von einem geilen Template für eine hervorragende SOftware hätte dann wirklich jeder was

  5. #5
    Kaiser(in)
    Themenstarter

    Registriert seit
    29.03.2009
    Ort
    1011 1111 1011 WorldWideWeb
    Beiträge
    2.439
    Danke
    2
    Bekam 6 mal "Danke" in 6 Postings

    Standard AW: Aussehen PHP-Dokumentation

    Ich wusste nicht, dass das teil Templates kennt - aber phpdocumentor erstellt doch einmalig html-dateien. Was ist mit späterenb änderungen oder verbesserungen?
    Zitat Zitat von jojo87
    Ohne dich beleidigen zu wollen denke ich nicht, dass du eine Software ähnlicher Qualität hinbekommst.
    Kommt drauf an, wie man das definiert. Evtl. nicht die gleichen (bzw. gleich guten) Qualitäten aber sicherlich andere auf änlichem Nevau.
    Der Sinn von phpdocumentore ist es doch, einaml geschriebenen code zu dokumentieren. Meine Software wird einen anderen zweck erfüllen, und ich möchte eben, dass sie schön aussieht xD
    Der, der weiß dass er nichts weiß, weiß mehr als der, der nicht weiß, dass er nichts weiß.
    Wer nach etwas fragt, geht grundsätzlich das Risiko ein, es auch zu bekommen!

  6. #6
    der/die Göttliche Avatar von jojo87
    Registriert seit
    23.03.2007
    Ort
    Leipzig
    Alter
    30
    Beiträge
    3.131
    Danke
    0
    Bekam 0 mal "Danke" in 0 Postings

    Standard AW: Aussehen PHP-Dokumentation

    Zitat Zitat von Tobse
    ich habe mich in letzter Zeit an einen automatischen PHP-Code Dokumentator gemacht


    Genau das macht PHPDoc.

    Zitat Zitat von Tobse
    Meine Software wird einen anderen zweck erfüllen
    Ja was denn nun?

    Zitat Zitat von Tobse
    Evtl. nicht die gleichen (bzw. gleich guten) Qualitäten aber sicherlich andere auf änlichem Nevau.
    Hä?
    Der Sinn von "Softwarequalitäten" (was für ein Wort) ist doch der, dass man sich auf welche einigt. Da fällt mir nur noch zu ein:

    Das schöne an Standards in der EDV ist, das jeder seine eigenen haben darf
    Zitat Zitat von Tobse
    aber phpdocumentor erstellt doch einmalig html-dateien. Was ist mit späterenb änderungen oder verbesserungen?
    Wo hast du das einmalig her? Du kannst PHPDoc so oft über deinen Code jagen wie du magst.
    Auch wenn ich mich wiederhole: An die Qualität dieses Programms kommst du nicht ran.
    Du begibst dich da quasi auf das Feld der statischen Codeanalyse, und das traue ich dir in dem Maße einfach noch nicht zu. Was nicht heißen soll, dass du mich/uns nicht vom Gegenteil überzeugen darfst
    Zudem ist PHPDoc in CI-Umgebungen wie Jenkins integriert und ein Defacto-Standard wie PHPUnit. Die Mühe wird sich bei deiner Eigenkreation (wegen obigen Qualitätsgründen) sicher niemand machen. Und Niveau ist keine Creme

    Zitat Zitat von Tobse
    Ich wusste nicht, dass das teil Templates kennt
    Jetzt weisst dus. Das sind allerdings keine Templates im eigentlichen Sinne, sondern Klassenpakete. Da wirst du dich selber reinfitzeln müssen, indem du dir mal die bereits existierenden anschaust.


  7. #7
    Kaiser(in)
    Themenstarter

    Registriert seit
    29.03.2009
    Ort
    1011 1111 1011 WorldWideWeb
    Beiträge
    2.439
    Danke
    2
    Bekam 6 mal "Danke" in 6 Postings

    Standard AW: Aussehen PHP-Dokumentation

    Also, PHPDocumentor erstellt einmalig HTML-Dateien mit nur infos aus den PHP-Dateien. Allerdings sind große Funktionsbeschreibungen wie in der PHP-Doku damit nicht möglich, man muss es hinterher in den HTML-Code reinfireimeln.
    Meine Software speicher das alles in SQL-Datenbanken, sodass man meinen Parser zwar auch nach jeder änderung über den code jagen kann - aber nicht muss sondern wenn es z.B. nur ein paar methoden sind sie im Web-Interface eintragen bzw. ändern.
    Momentan gibts noch keine Userverwaltung, aber es wird am Ende ungefähr so sein, dass z.B. jeder Entwickler eines Projekts seinen Code reinhauen kann und auch nur den bearbeiten, ann dem er gerade arbeitet und (je nach einstellung) von anderen Klassen/Funktionen nur den (programmiertecnisch) öffentlichen teil sieht.
    Oder eben dass z.B. ein Freeware Projekt die Doku online stellt (z.B. für eine Library) aber die Öffentlichkeit sieht nur die public felder, wärend den Entwicklern auch die protected und private gezeigt werden.

    Und als eine art nebenfeature muss dann eben noch ein Spider/Scanner her, der das ganze in unabhängige HTML-Dokumente exportieren kann.

    Zitat Zitat von jojo87
    Wo hast du das einmalig her? Du kannst PHPDoc so oft über deinen Code jagen wie du magst.

    Sicher kann ich das. Aber s.o. wegen änderungen/erweiterungen und der PHPDoc parser ist doch auch in PHP geschrieben, also stell ich mir das langsam vor. Ich habe meinen in Java geschrieben (wegen der Webserver unterschiedlichkeit) und er braucht für 250Kb Code c.a. 3 Sekunden (ohne auswertung durch PHP und Datenbankeintragung, versteht sich. Das hat glaub so 20 Sekunden gebraucht).
    Zitat Zitat von jojo87
    Auch wenn ich mich wiederhole: An die Qualität dieses Programms kommst du nicht ran.

    Nach meiner Erklärung oben ist glaub klar, dass ich eine andere Zielgruppe habe.

    Du begibst dich da quasi auf das Feld der statischen Codeanalyse, und das traue ich dir in dem Maße einfach noch nicht zu. Was nicht heißen soll, dass du mich/uns nicht vom Gegenteil überzeugen darfst

    Ich habe nicht ganz gelesen, inwiefern PHPDocumentor einzelne variablen verfolgt (in prozedualen scripts oder OOP Methoden). Klassen/Interface, Funktions und Methodendeklerationen funktionieren jedoch schon.


    Zitat Zitat von jojo87
    Und Niveau ist keine Creme

    Zum glück nicht. Aber genau deshalb will ich ja versuchen, es zu erreichen - ob ich dabei jetzt eine unnötige dopplung schaffe oder nicht (Mir persönlich ists egal).
    Geändert von Tobse (01.07.2011 um 17:02 Uhr)
    Der, der weiß dass er nichts weiß, weiß mehr als der, der nicht weiß, dass er nichts weiß.
    Wer nach etwas fragt, geht grundsätzlich das Risiko ein, es auch zu bekommen!

Ähnliche Themen

  1. Jung aussehen
    Von Unregistriert im Forum Off Topic und Quasselbox
    Antworten: 9
    Letzter Beitrag: 04.03.2009, 17:25
  2. Gute Dokumentation
    Von Bandit im Forum Flash Forum
    Antworten: 5
    Letzter Beitrag: 24.07.2008, 11:38
  3. Deutsche Dokumentation gesucht
    Von Tamara Mikes im Forum Zope & Plone - das deutsche Hilfeforum
    Antworten: 2
    Letzter Beitrag: 25.08.2007, 17:48
  4. Aussehen
    Von Ochsenfrosch im Forum Forum-Hilfe.de intern
    Antworten: 20
    Letzter Beitrag: 05.10.2005, 20:11

Stichworte

Berechtigungen

  • Neue Themen erstellen: Nein
  • Themen beantworten: Nein
  • Anhänge hochladen: Nein
  • Beiträge bearbeiten: Nein
  •