[Erledigt] wie schreibt man sauberen Code?

11.08.2004, 15:57

Hallo,
Ich programmiere(wenn man das schon unter programmieren verstehen kann

) zwar schon seit ein paar Jahren in diversen Spachen, habe mich jedoch noch nie dazu aufraffen können einen "sauberen" Code zu produzieren.

Jetzt, im Praxissemester, sollte ich wohl notgedrungen damit anfangen.

Gibt es Tutorial wie man Codestücke einrücken, beschreiben, groß/klein schreiben sollte, damit der Code gut leserlich bleibt?

Gerne auch Vorschläge in Buchform.

imported_Ben · 11.08.2004, 16:02

ist auf jeden fall eine offtopic-frage.
ich verschiebe es mal dahin.

zum thema einrücken:

http://tut.php-q.net/einruecken.html

ich persönlich schreibe klassen und deren objekte groß. also den anfangsbuchstaben.

in PHP schreibe ich weiterhin arrays so

Code:

$_array

und konstanten so:

Code:

_CONST

als beispiele.
je nach editor wird aber das einrücken schon automatisiert.

grüße ben

11.08.2004, 16:03

lol,
das muss jeder für sich selber abwägen, ob du den code übersichtlich findest oder nicht.

mfg
DarkManX

konsti · 11.08.2004, 16:04

1. kein goto
2. break nur in switch
3. einrücken (bei php und c(++) halt immer nach einem { eine enrückung weiter gehen)
4. sinnvolle variablennamen vergeben
5. eval vermeiden (php)
6. $_GET, $_POST, $_COOKIE, $_SERVER etc... verwenden
7. funktionen verwenden

11.08.2004, 16:06

.

Zitat:

das muss jeder für sich selber abwägen

Das Problem ist ja wohl nicht, ob ICH es übersichtlich finde, sondern ob es nach einem halbwegs verständlichen Muster bearbeitet wurde, um möglichen Lesern eine saubere und eindeutige Einstiegshilfe zu bieten.

Das dürfte ja auch ein Grund für UML sein... da jeder seine Beschreibung als gut empfunden hat

imported_Ben · 11.08.2004, 16:07

Zitat:

Zitat von DarkManX

das muss jeder für sich selber abwägen, ob du den code übersichtlich findest oder nicht.

das ist genau falsch. aber so richtig!

es interessiert nicht, ob man selbst den code übersichtlich findet, sondern ob andere ihn übersichtlich finden und sich schnell und ohne große probleme in ihm zurechtfinden können.

wenn das der fall ist, dann ist der code strukturiert.

die verwendung der OOP erleichtert dies natürlich stark!

edit:
da war wohl jemand schneller

supertramp · 11.08.2004, 19:53

es gibt teilweise Richtlinien, wie weit Code in diesem Punkte sauber sein muss, wenn man ihn abliefert. Ohne Kommentare braucht man da gar nicht erst anzufangen...
Die Kommentare brauchen manchmal mehr Zeit als der tricky-Code. Das ist den Unternehmen meist aber die Mehrinvestition wert.
Anschließend nämlich ist es billiger einen anderen in das Projekt zu integrieren oder das was auch immer zu erweitern.
Manchmal ist neu einfacher, wenn die Kommentare fehlen.

Das wirst du schon noch merken, wenn du Code anschaust, denn du vor 1-2-3 Jahren programmiert hast...

UniQ · 11.08.2004, 20:16

Was ist mit sowas wie PEAR-Richtlinien und PHPDoc-Kommentaren !?

-> http://www.pear.php.net/manual/en/standards.php
-> www.phpdoc.org

supertramp · 11.08.2004, 20:21

und sonst mal hier gucken:

27. Guter Code
http://www.dclp-faq.de/ch/ch-code.html

Guradia · 15.09.2004, 21:34

Weil ich gerade so ein niedliches Beispiel vor augen hatte (den größeren Block habe ich sogar schon ein bissle angepasst):

PHP-Code:

  <?php

 
        if ( !$zeile['bild']){$bild = "";}else {

            if ( $zeile['align']==1) {$ausr = "left";}else if($zeile[align]=="2"){$ausr = "right";}else{$ausr ="left";}

            $bild="<img src=\"$zeile[bild]\" border=\"0\" align=\"".$ausr."\"\">";}

 
            if(isset($_REQUEST['search']) || $_REQUEST['search']!=""){

                $high = $_REQUEST['search'];

                $harray = explode(" ", $high);

                $suche = $high;

                $s = explode(" ", $suche);

                while (list($key, $val) = each($s)) {

                    $out = @eregi_replace($val, "<span class=\"highlight\">\\0</span>", $out);

                }

            }

 
?>

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
Probleme mit PHP Code	HappyDieMuschel	PHP Tipps 2008	7	28.05.2008 06:34
[Erledigt] PHP Code aus Datenbank	ayti	PHP Tipps 2008	8	26.05.2008 19:40
Design und Code Trennen	TeazY	PHP Tipps 2008	29	21.05.2008 12:08
Nur bestimmten Html Code zulassen?	litterauspirna	PHP Tipps 2008	5	29.04.2008 12:30
Datei einfügen aus Ausgabepuffer, damit PHP Code funktionier	NetLook	PHP Tipps 2006	17	25.10.2006 15:09
PHP: Wie parst der Server den Code am schnellsten?	SvenLittkowski	PHP Tipps 2007	4	17.12.2005 10:58
bb code in htm code wandeln	janni	PHP Tipps 2007	2	04.11.2005 22:36
[Erledigt] JS Code in PHP Code??		HTML, Usability und Barrierefreiheit	12	08.08.2005 15:45
Seite 1/2/3..Code was haltet ihr davon?	Matthiasnet	PHP Tipps 2005-2	4	29.07.2005 20:29
[Erledigt] Lesbarkeit von Code		Off-Topic Diskussionen	6	14.07.2005 14:48
code aus db mit eval replacen	chief-thomson	PHP Tipps 2005-2	4	08.07.2005 15:33
Bestätigungmail code?		PHP Tipps 2005	7	16.05.2005 13:18
[Erledigt] BB Code entfernen		PHP Tipps 2005	2	25.04.2005 15:20
[Erledigt] bb code innerhalb von bb code geht nicht		PHP Tipps 2007	2	12.01.2005 17:29

11.08.2004, 15:57
Gast Beiträge: n/a	[Erledigt] wie schreibt man sauberen Code? Hallo, Ich programmiere(wenn man das schon unter programmieren verstehen kann ) zwar schon seit ein paar Jahren in diversen Spachen, habe mich jedoch noch nie dazu aufraffen können einen "sauberen" Code zu produzieren. Jetzt, im Praxissemester, sollte ich wohl notgedrungen damit anfangen. Gibt es Tutorial wie man Codestücke einrücken, beschreiben, groß/klein schreiben sollte, damit der Code gut leserlich bleibt? Gerne auch Vorschläge in Buchform.


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

11.08.2004, 16:02
imported_Ben Erfahrener Benutzer Registriert seit: 18.09.2003 Beiträge: 13.598 PHP-Kenntnisse: Fortgeschritten	ist auf jeden fall eine offtopic-frage. ich verschiebe es mal dahin. zum thema einrücken: http://tut.php-q.net/einruecken.html ich persönlich schreibe klassen und deren objekte groß. also den anfangsbuchstaben. in PHP schreibe ich weiterhin arrays so Code: $_array und konstanten so: Code: _CONST als beispiele. je nach editor wird aber das einrücken schon automatisiert. grüße ben __________________ Webentwickler-Blog - Buchbesprechung PHP Design Patterns - SQL-Antipatterns

11.08.2004, 16:03
Gast Beiträge: n/a	lol, das muss jeder für sich selber abwägen, ob du den code übersichtlich findest oder nicht. mfg DarkManX

11.08.2004, 16:04
konsti Erfahrener Benutzer Registriert seit: 19.06.2004 Beiträge: 665	1. kein goto 2. break nur in switch 3. einrücken (bei php und c(++) halt immer nach einem { eine enrückung weiter gehen) 4. sinnvolle variablennamen vergeben 5. eval vermeiden (php) 6. $_GET, $_POST, $_COOKIE, $_SERVER etc... verwenden 7. funktionen verwenden

11.08.2004, 19:53
supertramp Erfahrener Benutzer Registriert seit: 01.12.2003 Beiträge: 4.113	es gibt teilweise Richtlinien, wie weit Code in diesem Punkte sauber sein muss, wenn man ihn abliefert. Ohne Kommentare braucht man da gar nicht erst anzufangen... Die Kommentare brauchen manchmal mehr Zeit als der tricky-Code. Das ist den Unternehmen meist aber die Mehrinvestition wert. Anschließend nämlich ist es billiger einen anderen in das Projekt zu integrieren oder das was auch immer zu erweitern. Manchmal ist neu einfacher, wenn die Kommentare fehlen. Das wirst du schon noch merken, wenn du Code anschaust, denn du vor 1-2-3 Jahren programmiert hast... __________________ Aufstrebend, kompetent und werbefrei. www.developers-guide.net

11.08.2004, 20:16
UniQ Neuer Benutzer Registriert seit: 08.08.2004 Beiträge: 10	Was ist mit sowas wie PEAR-Richtlinien und PHPDoc-Kommentaren !? -> http://www.pear.php.net/manual/en/standards.php -> www.phpdoc.org

11.08.2004, 20:21
supertramp Erfahrener Benutzer Registriert seit: 01.12.2003 Beiträge: 4.113	und sonst mal hier gucken: 27. Guter Code http://www.dclp-faq.de/ch/ch-code.html __________________ Aufstrebend, kompetent und werbefrei. www.developers-guide.net

15.09.2004, 21:34
Guradia Erfahrener Benutzer Registriert seit: 21.05.2008 Beiträge: 2.150	Weil ich gerade so ein niedliches Beispiel vor augen hatte (den größeren Block habe ich sogar schon ein bissle angepasst): PHP-Code: <?php if ( !$zeile['bild']){$bild = "";}else { if ( $zeile['align']==1) {$ausr = "left";}else if($zeile[align]=="2"){$ausr = "right";}else{$ausr ="left";} $bild="<img src=\"$zeile[bild]\" border=\"0\" align=\"".$ausr."\"\">";} if(isset($_REQUEST['search']) \|\| $_REQUEST['search']!=""){ $high = $_REQUEST['search']; $harray = explode(" ", $high); $suche = $high; $s = explode(" ", $suche); while (list($key, $val) = each($s)) { $out = @eregi_replace($val, "<span class=\"highlight\">\\0</span>", $out); } } ?>