Ankündigung

Einklappen
Keine Ankündigung bisher.

Sauber Programmieren

Einklappen

Neue Werbung 2019

Einklappen
X
  • Filter
  • Zeit
  • Anzeigen
Alles löschen
neue Beiträge

  • Sauber Programmieren

    Hallo,

    ich bin neu hier im Forum und habe auch direkt zu beginn die Regeln des Forums gelesen und die Suche benutzt. Des Weiteren habe bin ich nun seit ca. einer Woche auf der Suche nach einer Lösung, welche ich selbst durch Google nicht finden kann. Ich vermute soetwas exestiert noch nicht.

    Ich arbeite seit einigen Jahren nun für eine Unternehmen, welches meine Programmierkünste dankend an nimmt. Allerdings muss ich mir off anhören: "Du solltest mehr Kommentare in deinen Quelltext einfügen!", dies belastet mich sehr. Wie schon oben beschrieben bin ich leicht verzweifelt was dies angeht.

    Ich benutze zum programmieren Dreamweaver, welches ich doch hervorragend finde. Nicht auf Grund der WYSIWYG-Funktionen sondern auf Grund der Optik und der Smooth'en -Funktionen.

    Ich bin also auf der Sache nach einem Programm/ einer Extension, welche es mir erleichtert die Kommentarfunktion zu tätigen, bzw. die notwendigen Kommentare zu hinterlassen um die Scripte mit dem PHP Documentor analysieren zu lassen. Ich habe bereits gesucht und wurde leider nicht fündig.

    Ihr seit meine letzte hoffnung. Wie macht Ihr das? Welchen Editor verwendet ihr?

    Das beste wäre, per Klick eine Kommentar-Eingabemaske zu öffnen, dort alle nötigen Daten einzugeben und per klick auf "OK" dies an der richtigen Stelle zu hinterlassen.

    Vielen lieben Dank.
    MoneY


  • #2
    Ich benutze seit längerem Eclipse mit PDT.
    Ob es dafür allerdings Erweiterungen für Kommentare gibt - keine Ahnung, das Eclipse-Universum ist groß und unübersichtlich
    Klassen- und Methoden-Kommentare habe ich mir ganz einfach als Vorlagen eingestellt, tippe ich "/**" wird daraus automatisch ein Kommentar mit den Parametern und ggfls. sonstigem Text.
    Aber egal wie toll die Kommentar-Funktion auch sein mag - wenn man sie nicht von sich aus nutzt hilft die Beste nichts.
    Welches Programm du also als IDE einsetzt ist primär erstmal unwichtig.

    BTW, übertreiben würde ich es mit Kommentaren übrigens auch nicht.
    Ein früherer Kollege hat für seine Methoden regelmäßig zwei bis drei Mal so viele Zeilen an Kommentaren geschrieben, wie diese nacher effektiv in Code waren.
    Sowas gehört dann mMn doch eher in eine separate Dokumentation.
    VokeIT GmbH & Co. KG - VokeIT-oss @ github

    Kommentar


    • #3
      Ich benutze den guten alten Notepad von Windows
      MfG
      ~Capfly

      Kommentar


      • #4
        Zend Studio for Eclipse

        Kommentar


        • #5
          Ich nutze Netbeans bzw. davor hatte ich Eclipse/Zend Studio genutzt. Wenn du dort vor einer Funktion/Methode einfach "/**" eingibst und auf Enter drückst erstellt er automatisch den phpDocumentor Kommentar und fügt schon mal bekannte Felder ein. Also Paramter oder return Werte. Dann musst du nur noch die entsprechende Bezeichnung eintippen und vlt. eine Beschreibung der Methode einfügen.

          Je nach dem was bei euch verlangt ist kannst du dann entsprechende phpDocumentor Tags hinzufügen um die Kommentare zu erweitern. Eine eigene Maske dafür nutz ich jetzt nicht. Ist mir soweit auch nicht bekannt. Großteile kann man meistens kopieren und dann kurz die Datei/Pfade/Module anpassen.

          Ansonsten einfach ein Codesnippet erstellen und dir auf eine Taste legen. Dann kannst du immer per Shortcut den Kommentar einfügen und entsprechend ergänzen.

          Kommentar


          • #6
            Vielen lieben Dank für eure hilfreiche Unterstützung.

            Eclips scheint mein Stichwort zu sein.

            Besten Dank für die schnellen Antworten.

            Kommentar


            • #7
              Von was für Kommentaren redest Du? PHPDoc? Ansosnten geht doch wohl nichts schneller als / / Leertaste einzugeben. Eingabemasken finde ich eigentlich immer den Tod für jede Eingabeperformance.
              --

              „Emoticons machen einen Beitrag etwas freundlicher. Deine wirken zwar fachlich richtig sein, aber meist ziemlich uninteressant.
              Wenn man nur Text sieht, haben viele junge Entwickler keine interesse, diese stumpfen Texte zu lesen.“


              --

              Kommentar


              • #8
                Zitat von nikosch Beitrag anzeigen
                Von was für Kommentaren redest Du? PHPDoc? Ansosnten geht doch wohl nichts schneller als / / Leertaste einzugeben. Eingabemasken finde ich eigentlich immer den Tod für jede Eingabeperformance.
                Sehe ich genauso. Ob nun // oder /**/ beides nicht sonderlich aufwendig ^^
                meine PHP Scripte

                Kommentar


                • #9
                  Ich benutze auf der Arbeit "Zend Studio 5.5.1" und "Netbeans 6.8"
                  Privat ausschließlich Netbeans.
                  Bin eigentlich sehr zufrieden mit beiden IDE's.


                  Was das kommentieren angeht, habe ich da folgende Einstellung, die auch von vielen anerkannten Programmierern so oder so ähnlich auch vertreten wird:

                  1. Man soll Funktionen und Klassen so schreiben, dass man den Sinn, was diese machen sollen in maximal 30Sekunden versteht. Wenn dies nicht der Fall ist, ist es schlecht programmiert.
                  2. Man soll den Code so schreiben, dass er sich wie ein englischen Buch lesen lässt. Das bedeutet in diesem Zusammenhang, dass ich überlange Namen in Kauf nehme, wenn diese dann genau erklären was eine Variable, Schleife oder Funktion genau machen soll

                  Wenn man sich an diese Regeln hält, braucht man eigentlich kaum Kommentare.
                  Natürlich muss man dazu sagen, dass dies wohl am besten bei OOP funktioniert.
                  "My software never has bugs, it just develops random features."
                  "Real programmers don't comment. If it was hard to write, it should be hard to understand!"

                  Kommentar


                  • #10
                    Zitat von MoneY Beitrag anzeigen
                    Hallo,
                    Ich benutze zum programmieren Dreamweaver, welches ich doch hervorragend finde. Nicht auf Grund der WYSIWYG-Funktionen sondern auf Grund der Optik und der Smooth'en -Funktionen.

                    Ich bin also auf der Sache nach einem Programm/ einer Extension, welche es mir erleichtert die Kommentarfunktion zu tätigen, bzw. die notwendigen Kommentare zu hinterlassen um die Scripte mit dem PHP Documentor analysieren zu lassen. Ich habe bereits gesucht und wurde leider nicht fündig.

                    Ihr seit meine letzte hoffnung. Wie macht Ihr das? Welchen Editor verwendet ihr?
                    Editor: Proton (Freeware, läuft ohne installation)
                    WYSIWYG = nur für HTML gut. und da reicht ein frontpage oder ähnliches vollkommen aus.

                    Ich empfehle dir radikale Trennung von HTML (GUI) + PHP-Code. Nutze die macht von Templates.
                    www.scriptforums.com - Foren für Skripts
                    www.ragonvote.net - Kostenlose Umfragen
                    www.ragonsoft.com - PHP und Android Apps (z. B. Knoten Video Guide)

                    Kommentar

                    Lädt...
                    X