Den eigenen Code lesbar im Forum präsentieren

Basi

Hallo liebe Forenmitglieder,

aus aktuellem Anlass klären wir in diesem Beitrag einmal wie man seinen eigenen Code hier im Forum so präsentieren kann, dass andere Mitglieder ihn leicht lesen können. Gehäuft konnte man beobachten, dass keine Codeblöcke (gleich mehr) genutzt wurden und der Quelltext vor lauter Leerzeilen überquoll, dies wollen wir möglichst verhindern da es unsere Arbeit deutlich erschwert.

Sollte dir etwas einfallen, was man diesem Beitrag noch hinzufügen könnte, bitte schreibe eine Private Nachricht an mich oder lauras.

Zusammenfassung

Bitte die BB-Codes zum hervorheben von Quelltext nutzen, wie das funktioniert wird weiter unten erklärt
Bitte unnötige Leerzeilen entfernen, zwischen 2 Codezeilen sollte maximal eine leere Zeile stehen
Bitte nicht den Quellcode eigenständig mit Farben versehen, das machen die Codeblöcke automatisch
Bitte ordentliche Tabgrößen nutzen, Einrückung ist gut, Einrückung mit 8 Leerzeichen pro Zeile ist schlecht (siehe unteres Ende des Beitrags)
Bitte möglichst vollständigen Code posten, mit kleinen Ausschnitten ist helfen meist schwer, oft muss zuerst nach mehr Code gefragt werden und das kostet Zeit
Fehlermeldungen angeben: Wir haben einen Beitrag dazu geschrieben wie ihr Fehlermeldungen entdecken könnt, dieser findet sich hier
Bitte nach Möglichkeit den Code irgendwo hochladen, am Besten bei einem gratis Hoster, oder kleinere Codes bei zum Beispiel JSFIDDLE, CodePen oder für z.B. PHP codepad oder 3v4l oder Ideone

Für PHP-Quelltext ist hier ein Beitrag zu finden wo diskutiert wird wie man sauberen Code schreibt.

Codeblöcke (Siehe auch: Forum - Hilfe - 4.3.16. Code)
Zuerst klären wir ab worum es sich bei den Codeblöcken handelt. Das Forum bietet beim Verfassen von Beiträgen die Möglichkeit Quelltext in einem abgetrennten Bereich anzuzeigen, dieser wird zusätzlich am linken Rand automatisch nummeriert:

HTML

Mein Code




Zeile 3 aus meinem Code

Dieser BB-Code wird verwendet wie jeder andere auch:

Code

[code=html]
Mein Code




Zeile 4 aus meinem Code

[/code]

Einrückung im Code wird somit beibehalten, wenn meine Codezeile 2 Leerzeichen am Anfang beinhaltet werden diese nicht entfernt, außerdem wird der Code farblich hervorgehoben:

HTML

<body>
    <header>
      <h1>Meine Überschrift</h1>
    </header>
    [...]

Nun bietet das Forum nicht nur BB-Code für HTML Blöcke sondern auch für PHP, SQL, CSS, JavaScript und einen für sonstigen Code (ohne farbliche Hervorhebung), diese schreiben sich wie folgt:

Code

[code=php]   Mein PHP-Code

SQL

Mein SQL-Code

CSS

Mein CSS-Code

HTML

Mein HTML-Code

JavaScript

Mein JavaScript-Code

[/code]html-seminar.de/woltlab/attachment/551/Entweder schreiben wir den BB-Code selber oder wir nutzen die vorgegebenen Schaltflächen. ^{(siehe Bild)}

Weiterführended
Es kann manchmal sinnvoll sein wenn bei Ausschnitten die Nummerierung am Rand nicht bei 1 beginnt sondern mit den Zahlen aus der kompletten Datei übereinstimmt, hierzu können wir die Zahl mit der begonnen wird angeben:

Code

[code=php,381]

[/code]

PHP: 381

function chance($value){
    if($value > 100 || $value < 0)
        return false;
    else if($value == 100)
        return true;
    else if(rand(1, 100) < $value)
        return true;
    else
        return false;
}

Schlechte Einrückung vermeiden:

HTML

<!-- Das Problem bei zu großen Tabgrößen wird schnell deutlich: -->
<body>
        <header>
                <h1>
                        Meine Überschrift
                </h1>
        </header>
        <nav>
                <ul>
                        <li>
                                <a href="#">
                                        Link
                                </a>
                        </li>
                        <li>
                                <a href="#">
                                        Link
                                </a>
                        </li>
                </ul>
        </nav>
</body>

Alles anzeigen

Jetzt mitmachen!