Strukturierung von Sourcecode. Wie macht ihr das?

... komplette Frage anzeigen

4 Antworten

Das ist ein weites Thema. Man kann es unter dem Begriff "best practices" festmachen - es gibt für alle Teilbereiche der Organisation von Sourcecode erprobte Praktiken. Das hier rein zu schreiben würde hier zu weit führen. Hier nur ein paar Ansatzpunkte:

- Formatiere den Code ordentlich - das bedeutet in erster Linie sauberes Einrücken von Elementen.

- Benenne deine Variablen sinnvoll. Alle Variablen ausser solche die wirklich nur für kurze zwischenrechnungen verwendet werden (die können auch $a oder $b heissen) sollten einen Namen haben aus dem man seine Funktion ablesen kann. Eine Liste von Usern z.B. $users usw. Schleifenvariablen werden mit $i, $j, $k usw. benannt.

- Kommentiere die Codeteile die wirklich schwer verständlich sind. Ansonsten sollte gut geschriebener Code sich in erster Linie selber kommentieren.

- Benutze so etwas wie PHPDoc um zum Beispiel Funktionsdeklarierungen zu dokumentieren. 

- Ganz wichtig: Benutze ein Code Repository. Also Git oder Subversion, ich empfehle Git. Damit kannst du jeden Schritt der Weiterentwicklung nachvollziehen und im Zweifelsfall auch rückgängig machen.

- Beschäftige dich mit Entwurfsmustern (Programming Pattern). Das wichtigste Pattern in der Web-Entwicklung ist das Model-View-Controller Pattern (MVC)

- Sorge für eine logische Ordnerstruktur

- Arbeite mit einem Framework - schreibe nicht deinen ganzen Code von null auf neu sondern nutze ein Framework wie z.B. Yii in PHP.

- Schreibe automatisierte Tests

Antwort bewerten Vielen Dank für Deine Bewertung

Ich schreibe meine programme und webanwendungen auf die ich in dem post auch eingehe eigentlich vorwiegend immer auf einem lokalem entwicklungslaptop. Eingesetzt wird aus bequemlichkeit ubuntu. Die software für db,webserver,php sind aber die selben die ich in der Produktionslinie auch einsetze. Das ist mir wichtig. Ich persönlich dokumentiere bzw kommentiere meinen code eigentlich nur sehr sehr sehr selten. Kleinere bugfixes etc mache ich live und neuerungen die noch zum test ausstehen werden intern besprochen und getestet (abgeschottet von der öffentlichen version) und entstehen von der quelle her eigentlich auch wieder nur lokal am entwicklungslaptop. Funktions und sicherheitstests folgen eigentlich immer dann wenn das modul fertig ist (& insofern vorhanden die anderen module sofern sie eine abhängigkeit darstellen ebenfalls fertig sind.)

Antwort bewerten Vielen Dank für Deine Bewertung

Dokumentieren tue ich eigentlich nichts - der Code ist ja nur für mich und guter Code sollte sowieso sprechend genug sein, sodass Doku/Kommentare fast ganz unnötig werden. Was ich in C# mache und in PHP jetzt auch vermehrt: DocComments für Klassen/Methoden dazuschreiben!

Zur Versionsverwaltung nutze ich inzwischen Subversion. Habe nur meine aktuellen Projekte da drauf zur Zeit, aber werde da ältere - wenn ich sie mal bearbeite - auch hochladen. Getestet wird alles offline - habe in meinem XAMPP Order zig Projekte und auch die Datenbanken dazu - alles lokal. Wenn alles getestet ist und es geht, dann wird es hochgeladen auf das live-System. Dazwischen liegen aber meist einige SVN-commits ;)

Arbeite z.Zt an etwas komplexerem (viele Klassen und Vererbung etc.), da habe ich mir dann auch mal paar UML-Diagramme grob hingemalt - einfach um vorher zu sehen was wohin kommen sollte..

Aber ich denke eher dein Problem ist der Code selbst, oder?


PS: Stichwort "Refactoring".. ab und zu muss man einfach mal den Code verbessern statt weiter zu entwickeln ;)

Antwort bewerten Vielen Dank für Deine Bewertung
Kommentar von Dereta
09.11.2016, 17:16

Nein :D Das Problem ist nicht der Code, sondern eher die Benennung der Funktionen/Variablen und natürlich auch Parametern. 

Also indirekt blicke ich nach 2-3 Wochen noch durch. Aber dann verliere ich auch oft einfach das Interesse, weil ich mir den Berg an arbeit den ich noch vor mir habe anschaue und dann geht die Lust halt einfach verloren. Und ich weiß nicht wie ich das auf dauer ändern kann. 

Habe locker schon 20-30 Projekte so angefangen aber nie beendet.

Egal ob Websiten, Programme oder eben andere Projekte..

Vielen dank für alle Antworten

Grüße Benjamin

0

Die hiesigen Tipps gelten auch sinngemäss für das Entwickeln von Webseiten:

http://de.wikipedia.org/wiki/Clean_Code

Das angegebene Buch sollte früher oder später vollständig in den grauen Zellen des Hirns verankert sein! Besser und prägnanter kann man es nicht formulieren!

Antwort bewerten Vielen Dank für Deine Bewertung

Was möchtest Du wissen?