Hilfe:Artikel/Codingstyle

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

Für jedes Projekt, an dem mehrere Entwickler arbeiten, ist es notwendig, Festlegungen für den Programmierstil zu treffen. Die hier verwendeten Vorgaben sind weit verbreitet und anerkannt. Sie sollen in diesem Wiki Anwendung finden.

Mediawiki[Bearbeiten]

Setze jeweils ein Leerzeichen zwischen Überschrift und Überschriften-Tags.

==Überschrift==
== Überschrift ==


Setze ein Leerzeichen nach den Aufzählungs-Tags.

*listitem (ungeordnete Liste)
#listitem (geordnete Liste)
;listitem (Beschreibungsliste, dt)
:listitem (Beschreibungsliste, dd)
* listitem (ungeordnete Liste)
# listitem (geordnete Liste)
; listitem (Beschreibungsliste, dt)
: listitem (Beschreibungsliste, dd)

HTML[Bearbeiten]

Verwende den korrekten Doctype.

<!DOCTYPE html>


Schreibe Elemente und Attribute mit kleinen Buchstaben.

<MAIN>
  <H1>Überschrift</H1>
  <P>Ein Textabsatz mit <A HREF="https://example.com">Link</A></P>
</MAIN>
<main>
  <h1>Überschrift</h1>
  <p>Ein Textabsatz mit <a href="https://example.com">Link</a></p>
</main>


Notiere auch optionale Tags.

<ul>
  <li>Listitem
  <li>Listitem
</ul>
<ul>
  <li>Listitem</li>
  <li>Listitem</li>
</ul>


Verwende eine Einrückungstiefe von 2 Leerzeichen.

<nav>
  <h2>Navigation</h2>
  <ul>
    <li>Menüpunkt</li>
  </ul>
</nav>


Öffnende Tags von strukturierenden Elementen und schließende Tags von Container-Elementen stehen im Allgemeinen in einer neuen Zeile.

<main><h1>Überschrift</h1>
  <p>Ein Textabsatz</p></main>
<main>
  <h1>Überschrift</h1>
  <p>Ein Textabsatz</p>
</main>


Attributwerte werden in doppelte Anführungszeichen eingeschlossen, das Gleichheitszeichen steht ohne Leerzeichen.

<p class="klassenbezeichner">Ein Textabsatz</p>

CSS[Bearbeiten]

Nach dem Doppelpunkt folgt ein Leerzeichen.

Auch die letzte Deklaration wird mit einem Semikolon abgeschlossen.

Die Einheit nach einer Null kann – falls möglich – weggelassen werden.

Jede Deklaration steht in einer eigenen Zeile, einzeilige Regeln sollen in einer Zeile geschrieben werden.

p { margin: 0px; padding:0; }
p {
  margin: 0;
  padding: 0;
}
p { margin: 0; }

JavaScript[Bearbeiten]

PHP[Bearbeiten]