Programmierstiel und Vorgaben

[felix]

Hi zusammen,

ich lege in der Regel (OK, OK erst seit meinem neuen Projekt) "relativ" viel Wert auf ein korrekten Programmierstil. Jedoch hinke ich oft den aktuellen Vorgaben hinterher und habe kaum Zeit mich da zu informieren.

Vielleicht könnt Ihr mir da ja ein paar Tipps geben.

Ich benutze zum Programmieren (Hauptsächlich PHP, HTML, JavaScript, CSS) den Editor Phase 5.3 . Bin sehr zufrieden mit dem Editor.

Wenn ich z.B. ein <input> Feld schreibe und den Tag dann schließe, erstellt einem phase5 den Text zum schließen des Tags. Aber ich wusste z.B. nicht, dass man <input type="text" name="" value=""></input> macht. Ich habe noch nie den input-tag geschlossen.

Man mach das doch mit <input type="text" name="" value="" /> oder ?
Und hinter welche Tags macht man eigentlich das /.

Bin da nen bischen ... *räuser* schlampig mit.

Grüße, Felix

[Danny]

Hi,

finde ich gut.  Korrekter Stil ist wichtig, vor allem wenn mehrere Personen daran arbeiten.

HTML und CSS sind keine Programmierspachen aber das spielt hier keine Rolle. In HTML sind einige Ende-Tags optional (welche siehe SelfHTML).
In XHTML, bzw. XML sind sie jedoch alle Pflicht. <input></input> ist also wohlgeformtes XHTML, während <input> nur dem HTML-Standard genügt.
<input /> ist die XML-, bzw. XHTML-Kurzform von <input></input> aber nach HTML-Standard streng genommen unbekannt, bzw. falsch.
Ist das Dokument lt. Doctype XHTML, dann ist <input /> oder <input></input> ok, bei Doctype HTML nur <input> oder <input></input>

freundlichen Gruß
Danny

[Tom]

Hello,

finde ich gut.  Korrekter Stil ist wichtig, vor allem wenn mehrere Personen daran arbeiten.

ich auch. Wer den Stil nicht einhält, bekommt es mit dem Stiel! Richtig so.

in HTML können einrückungen und Zeilenumbrüche schon hässliche Folgen haben. Sie werden immer als ein Leerzeichen gewertet und manche Browser verhalten sich da sehr unkooperativ. Ein Leerzeichen vor einem <img> wird im IE z.B. anders gewichtet, als eines danach.

<td>
   <img ...>
 </td>

ist also nicht möglich

Warum dann aber

<td>
   <img ...></td>

das gleiche Ergebnis bringt (in einigen Browsern), wie

<td><img ...></td>

das habe ich noch niocht verstanden. Kann ich wahrscheinlich auch nicht. Das muss man sich nur merken.

Es gibt außerdem bei PHP den PEAR-Standard, den ich bis auf "meine Macke" mit den Öffnungsklammern eines Blockes auch für sinnvoll halte. Den schau Dir mal an. Und wenn Du Dich meiner Abwandlung

function bla($blub)
 {
   # hier beginnt der Körper
 }

anschließen kannst, dann freu ich mich.

Die öffenende und die schließende Klammer symbolisieren eine Hierarchieebene. Da Hierarchien in der Programmierung meistens waagerecht durch Einrückungen dargestellt werden, ist das also logisch und leicht erkennbar. Außerdem gibt es Editoren mit Highlighting bei den Klammern. Wenn ich auf eine klicke, wird mir die zweite auch farbig angeztigt und wenn die dann übereinander stehen, passen zumindest die Klammern in diesem Abschnitt.

Harzliche Grüße aus http://www.annerschbarrich.de

Tom

[felix]

Hi,

übersichtlicher finde ich das hier:

<td>
INHALT
</td>

als

</td>
inhalt</td>

Bei der oberen Variante habe ich doch "alles" im Blick.

Genau das mit funktionen:

function ding($dong)
{
 INHALT
}

ist übersichtlicher als:

function ding($dong) {
INHALT
}

obwohl ich immer die zweite Variante nehme. Warscheinlich weil ich es so gelernt habe.

Gibt es da denn genaue Vorgaben wie es korrekt wäre ? (So lange der Code richtig abgearbeitet wird, sollte das ja nichts ausmachen. Die Übersicht wächst "nur").

Grüße Felix

[Tom]

Hello,

übersichtlicher finde ich das hier:

<td>
INHALT
</td>

Das geht aber nicht

</td>inhalt</td>

Bei der oberen Variante habe ich doch "alles" im Blick.

meine ich auch. Macht aber Probleme mit dem Whitespace. Ist ja bei Inline-Elementen auch logisch, wenn  noch was folgen würde. Hier folgt aber nichts mehr.
Allerdings werden sonst die ersten und letzen auch weggeschnitten.

Genau das mit funktionen:

function ding($dong)
{
 INHALT
}

ist übersichtlicher als:

Darum benutze ich das auch. Es lässt sich auch besser kommentieren.

Harzliche Grüße aus http://www.annerschbarrich.de

Tom

[felix]

Hello,

übersichtlicher finde ich das hier:

<td>
INHALT
</td>

Das geht aber nicht

hmmm ? Ist dieser Tabellenaufbau nicht normal ?
Steht zumindest unter: http://de.selfhtml.org/html/tabellen/aufbau.htm

Also:

<table>
<tr>
<td>
  INHALT
</td>
</tr>
</table>

Habe gerade gesehen, dass unter der URL die erste Reihe mit <th></th> beginnt. Ist das Pflicht ?

</td>inhalt</td>

</td> bzw </TAG> schließt doch einen Tag. Warum dann </td>Inhalt</td> ?

Bei der oberen Variante habe ich doch "alles" im Blick.
meine ich auch. Macht aber Probleme mit dem Whitespace. Ist ja bei Inline-Elementen auch logisch, wenn  noch was folgen würde. Hier folgt aber nichts mehr.

Also wenn nichts mehr folgt dann einfach nur <td> oder </td> ? oder kann man auch das so machen:

<table>
<tr>
<td /> INHALT SPALTE 1 ZEILE 1
<td /> INHALT SPALTE 2 ZEILE 1
<td /> INHALT SPALTE 3 ZEILE 1
</tr>
<tr>
<td /> INHALT SPALTE 1 ZEILE 2
<td /> INHALT SPALTE 2 ZEILE 2
<td /> INHALT SPALTE 3 ZEILE 2
</tr>
</table>

Grüße, Felix

[MudGuard]

Hi,

</td>inhalt</td>

</td> bzw </TAG> schließt doch einen Tag. Warum dann </td>Inhalt</td> ?

https://forum.selfhtml.org/?t=87101&m=516990

Also wenn nichts mehr folgt dann einfach nur <td> oder </td> ? oder kann man auch das so machen:
<td /> INHALT SPALTE 1 ZEILE 1

Dann stünde INHALT SPALTE 1 ZEILE 1 direkt im tr-Element, welches aber nur td- und th-Elemente enthalten darf.

cu,
Andreas

[felix]

Hi

</td>inhalt</td>

</td> bzw </TAG> schließt doch einen Tag. Warum dann </td>Inhalt</td> ?

https://forum.selfhtml.org/?t=87101&m=516990

Na super, da dachte ich schon hier will mir jemand was falsches unterjubeln, dabei war ich es der ausversehen (Tippfehler), der die Zeile "ins Leben gerufen" hat. Sorry!

Also wenn nichts mehr folgt dann einfach nur <td> oder </td> ? oder kann man auch das so machen:
<td /> INHALT SPALTE 1 ZEILE 1

Dann stünde INHALT SPALTE 1 ZEILE 1 direkt im tr-Element, welches aber nur td- und th-Elemente enthalten darf.

Alles klar, vielen Dank !

Grüße, Felix

[Johannes Zeller]

Hallo Felix,

Habe gerade gesehen, dass unter der URL die erste Reihe mit <th></th> beginnt. Ist das Pflicht ?

Nein, das TH-Element ist eine Tabellenzelle, die als Überschrift oder ähnliches dient. Es gibt jedoch keine Vorschriften oder Beschränkungen, wo du diese einsetzen darfst. Trotzdem sollte am Ende natürlich ein sinnvoller Tabellenaufbau herauskommen ;-)

Schöne Grüße,

Johannes

[Johannes Zeller]

Hallo Felix,

übersichtlicher finde ich das hier:

<td>
INHALT
</td>

als

</td>
inhalt</td>

Bei der oberen Variante habe ich doch "alles" im Blick.

Ich bevorzuge die Variante

<td>Inhalt</td>

Bei längeren Inhalten breche ich vor 80 Zeichen um, sodass dann daraus
so etwas ähnliches wird.

<td>Inhalt Inhalt Inhalt Inhalt Inhalt
  Inhalt Inhalt</td>

Mit Syntax-Highlighting, bleibt es dennoch sehr übersichtlich. Bei der anderen Form verbrauche ich bei großen Tabellen zu viele Zeilen, was den Quelltext jedenfalls für micht unübersichtlicher macht.

Genau das mit funktionen:

function ding($dong)
{
INHALT
}

ist übersichtlicher als:

function ding($dong) {
INHALT
}

obwohl ich immer die zweite Variante nehme. Warscheinlich weil ich es so gelernt habe.

Bei Funktionen und Klassen wähle ich die erstere Variante, lediglich bei niedrigeren Blöcken, wie Schleifen oder if-Abfragen, verwende ich die zweite Form.

Gibt es da denn genaue Vorgaben wie es korrekt wäre ?

Ohne Leerzeichen vor dem Fragezeichen ;-)

Solange du nicht an einem Projekt mit festen Vorgaben arbeitest, ist es völlig egal, wie du deinen Code formatierst. Es gibt kein richtig oder falsch. Allerdings ist es trotzdem eine gute Idee, sich persönliche Formatierungsrichtlinien zu setzen, damit der Code schön übersichtlich bleibt.

Auch die Formatierungsrichtlinien von bekannten Projekten, bei PHP z.B. die von PEAR: http://pear.php.net/manual/en/standards.php werden von vielen Programmieren gern als Anregung genommen.

Schöne Grüße,

Johannes

[MudGuard]

Hi,

HTML und CSS sind keine Programmierspachen aber das spielt hier keine Rolle. In HTML sind einige Ende-Tags optional (welche siehe SelfHTML).
In XHTML, bzw. XML sind sie jedoch alle Pflicht. <input></input> ist also wohlgeformtes XHTML, während <input> nur dem HTML-Standard genügt.
<input /> ist die XML-, bzw. XHTML-Kurzform von <input></input> aber nach HTML-Standard streng genommen unbekannt, bzw. falsch.
Ist das Dokument lt. Doctype XHTML, dann ist <input /> oder <input></input> ok, bei Doctype HTML nur <input> oder <input></input>

Zur Ergänzung: in XHTML ist zwar <input></input> usw. zulässig - aber diverse Browser kommen dabei ins Schleudern.
Bei Elementen mit content model EMPTY sollte also die Schreibweise <input /> (mit Leerzeichen vor dem /) verwendet werden.
Für Elemente mit anderem content model sollte die Schreibweise mit 2 Tags (<element></element>) verwendet werden, auch wenn im konkreten Fall kein Inhalt vorhande ist und damit die Schreibweise <element /> auch zulässig wäre.

cu,
Andreas

[Gunnar Bittersmann]

Für Elemente mit anderem content model sollte die Schreibweise mit 2 Tags (<element></element>) verwendet werden, auch wenn im konkreten Fall kein Inhalt vorhande ist und damit die Schreibweise <element /> auch zulässig wäre.

Andreas,
Das W3C widerspricht sich da selber.

In der XML-Spec http://edition-w3c.de/TR/2000/REC-xml-20001006/#sec-starttags heißt es:
Leeres-Element-Tags können für jedes Element benutzt werden, das keinen Inhalt hat, unabhängig davon, ob es mit dem Schlüsselwort EMPTY deklariert wurde. Zwecks Zusammenarbeit sollte das Leeres-Element-Tag für Elemente benutzt werden, die als EMPTY deklariert sind, und nur für solche.

Aber in der XHTML-Spec http://www.edition-w3c.de/TR/2002/REC-xhtml1-20020801/#heading-4.3:
Alle Elemente, die in der DTD nicht als EMPTY deklariert sind, müssen ein End-Tag haben. Elemente, die in der DTD als EMPTY deklariert sind, können ein End-Tag haben oder die Kurzschreibweise verwenden.

Allerdings kommt auch <p/> durch den Validator. Hm.

Gunnar

[MudGuard]

Hi,

Allerdings kommt auch <p/> durch den Validator. Hm.

Sag ich ja. Formal korrekt. Aber um der Browser willen sollte es nicht benutzt werden.

Die Tatsache, daß XML <p/> erlaubt, kann durch die konkrete XML-Anwendung XHTML zwar im Text, aber nicht formal, aufgehoben werden. Daher meckert der Validator auch nicht.

Der von Dir genannte Abschnitt (bzw. das Original http://www.w3.org/TR/xhtml1/#h-4.3) steht außerdem in einem nicht-normativen Teil des Standards ...

cu,
Andreas

[Thomas J.S.]

Hallo,

In der XML-Spec http://edition-w3c.de/TR/2000/REC-xml-20001006/#sec-starttags heißt es:
Leeres-Element-Tags können für jedes Element benutzt werden, das keinen Inhalt hat, unabhängig davon, ob es mit dem Schlüsselwort EMPTY deklariert wurde. Zwecks Zusammenarbeit sollte das Leeres-Element-Tag für Elemente benutzt werden, die als EMPTY deklariert sind, und nur für solche.

Aber in der XHTML-Spec http://www.edition-w3c.de/TR/2002/REC-xhtml1-20020801/#heading-4.3:
Alle Elemente, die in der DTD nicht als EMPTY deklariert sind, müssen ein End-Tag haben. Elemente, die in der DTD als EMPTY deklariert sind, können ein End-Tag haben oder die Kurzschreibweise verwenden.

Ich sehe das ein wenig anderes mit dem Widerspruch:

XML:
<!ELEMENT A EMPTY>
<!ELEMENT B (#PCDATA)>

<A />
<B /> wobei <B></B> benutzt werden sollte.

XHTML:
http://www.w3.org/TR/2002/REC-xhtml1-20020801/#guidelines C.2 und C.3

Grüße
Thomas

[Johannes Zeller]

Hallo Gunnar,

Du hast da etwas missverstanden:

Aber in der XHTML-Spec http://www.edition-w3c.de/TR/2002/REC-xhtml1-20020801/#heading-4.3:
Alle Elemente, die in der DTD nicht als EMPTY deklariert sind, müssen ein End-Tag haben.

Hierbei geht es um Elemente, bei denen man in HTML, obwohl sie einen Inhalt haben, ein oder beide Tags weglassen kann.

So wäre:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
    <title>Blubb</title>
    <p>Blah

eine valide HTML-Seite. In XHTML muss die gleiche Seite mindestens so aussehen:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN">
    <html>
        <head>
            <title>Blubb</title>
        </head>
        <body>
            <p>Blah</p>
        </body>
    </html>

Elemente, die in der DTD als EMPTY deklariert sind, können ein End-Tag haben oder die Kurzschreibweise verwenden.

Das besagt, dass leere Elemente, z.B. BR, IMG oder INPUT entweder mit Start- und End-Tag (<br></br>, <img ...></img>, <input...></input>) oder in der Kurzschreibweise <br />, <img ... />, <input ... /> geschrieben werden können. Lediglich, die in HTML vorgesehen
Schreibweise _ohne_ End-Tag (<br>, <img ...>, <input ...>) darf nicht
mehr verwendet werden.

Aus Rücksicht, auf Browser sollte man, aber die Kurzschreibe _mit Leerzeichen_ verwenden. Zumindest dann, wenn man das XHTML aus Kompatibilitätsgründen als text/html ausliefert. Auch die zulässige
Schreibweise <br/>, <img .../>, <input .../> kann zu Problemen führen.

Allerdings kommt auch <p/> durch den Validator. Hm.

Ja, es ist ja korrektes XHTML. Die Schreibweise <p></p> ist jedoch kompatibel zu HTML und deshalb vorzuziehen.

Schöne Grüße,

Johannes

[Gunnar Bittersmann]

Aber in der XHTML-Spec http://www.edition-w3c.de/TR/2002/REC-xhtml1-20020801/#heading-4.3:
Alle Elemente, die in der DTD nicht als EMPTY deklariert sind, müssen ein End-Tag haben.

Hierbei geht es um Elemente, bei denen man in HTML, obwohl sie einen Inhalt haben, ein oder beide Tags weglassen kann.

Johannes,
Stimmt. Wer lesen kann, ist im Vorteil.

Ich hatte den Satz ohne den Zusammenhang zu den vorhergehenden ("... XML erlaubt das Weglassen von End-Tags nicht.") falsch interpretiert.
Gunnar

[Franz]

Soweit ich weiß gilt die ganze Geschichte erst ab XHTML. XHTML basiert auf XML und da sind keine tags erlaubt, die nicht geschlossen werden.
Du musst also bei allen tags, die keinen Abschlusstag haben wie z.b.
img, input etc. den abschließenden Schrägstrich vor dem > machen.
Das was dein Editor da treibt ist auch zulässig denke ich. Am Besten gehst du auf Nummer sicher und benutzt den HTML-Validator (einfach mal danach googlen). Der meldet jeden Fehler, der gegen die Standards des W3C verstößt.

[felix]

Das was dein Editor da treibt ist auch zulässig denke ich. Am Besten gehst du auf Nummer sicher und benutzt den HTML-Validator (einfach mal danach googlen). Der meldet jeden Fehler, der gegen die Standards des W3C verstößt.

Guter Tipp, danke !

Grüße Felix

[Johannes Zeller]

Hallo Franz (</faq/#Q-05a>)

Am Besten gehst du auf Nummer sicher und benutzt den HTML-Validator (einfach mal danach googlen). Der meldet jeden Fehler, der gegen die Standards des W3C verstößt.

Das kann ich so nicht unkommentiert stehen lassen. Der Validator
überprüft lediglich ob das XHTML-Dokument alle Anforderungen der XHTML-DTD entspricht. In der XHTML-Spezifikationen werden jedoch noch weitere Anforderungen festgelegt (http://www.w3.org/TR/2002/REC-xhtml1-20020801/#prohibitions). Da sich diese jedoch in XML, worin die XHTML-DTD geschrieben ist, nicht ausdrücken lassen, erkennt der Validator verstöße dagegen nicht.

So hält er z.B. die Seite http://www.zeller-johannes.de/misc/xhtml-nonvalid.html für valide: http://validator.w3.org/check?uri=http%3A%2F%2Fwww.zeller-johannes.de%2Fmisc%2Fxhtml-nonvalid.html.

Daneben hat er auch noch weitere Einschränkungen: http://openjade.sourceforge.net/doc/xml.htm.

Schöne Grüße,

Johannes

[Bio]

Sup!

Die Bevölkerung ist nicht mehr länger in der Lage, das Wort "Stil" vom "Stiel" zu differenzieren. Darum sollte beides künftig "Schtiel" geschrieben werden.

Gruesse,

Bio

[Stefan Muenz]

Hallo Bio,

Die Bevölkerung ist nicht mehr länger in der Lage, das Wort "Stil" vom "Stiel" zu differenzieren. Darum sollte beides künftig "Schtiel" geschrieben werden.

Da werden sich aber die Hanseaten beschweren! "Sch..." sagt man nicht vor 't' und 'p'. Und Sprecher wie Helmut Kohl ziehen ein "ch" wie in "weich" vor, also "Chtiel". Und was lernen wir daraus? Es ist kein Zufall, dass die Schriftsprache leicht abweicht von der gesprochenen - schon allein wegen der zahlreichen dialektalen Sprechvarianten. Allerdings sollte die geschriebene Sprache auch nicht zu stark von der gesprochenen abweichen, sonst sind wir irgendwann so weit wie die Sprecher des Englischen, die 'a' schreiben, aber es als helles 'o' oder 'ä' sprechen.

viele Gruesse
  Stefan Muenz

[felix]

Ich sage mal Dialekt ist eine Sache. Ich spreche sowohl badischen Dialekt als auch Hochdeutsch (mehr oder weniger). Im Badischen gibt es das Wort Stil nicht, da gibt es eher Schtiel :)

Trotzdem sollte ich in der Lage sein, hochdeutsch bzw. nach der Deutschen Rechtschreibreform meine Sätze formulieren zu können. Da merk ich sofort, wenn man sich nicht einigermaßen konzentriert.
Ist schon peinlich.
Ich tippe und tippe. Da passiert es schonmal das man Buchstaben umdreht oder ähnliches. Beispiel: das udn ODER: dasu nd (Zu schnell getippt). Ich lass es meistens so stehen. Der "Andere" weiß schon was ich meine.

So verschlechtet sich doch sicherlich die Deutsche Sprache bzw. die Rechtschreibung oder ? Habt ihr nicht ICQ ? oder chattet im IRC ?
Da ist man immer schnell am tippen und macht auch sicherlich viele Fehler.

Grüße,

Felix

[Matti Maekitalo]

use Mosche;

Ich tippe und tippe. Da passiert es schonmal das man Buchstaben umdreht oder ähnliches. Beispiel: das udn ODER: dasu nd (Zu schnell getippt). Ich lass es meistens so stehen. Der "Andere" weiß schon was ich meine.

So verschlechtet sich doch sicherlich die Deutsche Sprache bzw. die Rechtschreibung oder ? Habt ihr nicht ICQ ? oder chattet im IRC ?
Da ist man immer schnell am tippen und macht auch sicherlich viele Fehler.

Ich tippe auch einigermaßen schnell, aber ich benutze die Rechschreibprüfung meines Browsers, der mir alle (ihm) unbekannten Wörter rot markiert, und dann sehe ich recht schnell, ob ich ein Wort falsch geschrieben habe. Ich denke weiterhin, daß man sein Posting schon mal kurz überfliegen sollte, ob da nicht irgendwelche Fehler drin sind - die werden auch korrigiert! Denn das, was ich schreibe, ist das einzige, was der Leser (am anderen Ende der Leitung) von mir mitbekommt. Und da will ich schon einen guten Eindruck machen.

use Tschoe qw(Matti);

[felix]

Hi,

Denn das, was ich schreibe, ist das einzige, was der Leser (am anderen Ende der Leitung) von mir mitbekommt. Und da will ich schon einen guten Eindruck machen.

Stimmt. Die Rechtschreibfunktion nutze ich nicht, da ich gar nicht weiß wo ich die finde :P

Aber dein Browser kann keine neue Rechtschreibreform oder ?
»», daß man ...

:o)

Aber ich stimme Dir vollkommen zu.

Grüße Felix

PS: Guter Eindruck wurde hinterlassen :P

[felix]

ROFL, gar nicht gehsen. Wie peinlich. I´m sorry.

Stil :-)

[Christian Kruse]

Hallo felix,

Man mach das doch mit <input type="text" name="" value="" /> oder?

nur bei XHTML bzw. XML. HTML ist eine SGML-Anwendung, und bei SGML
ist <tag /> das gleiche wie <tag >>. Es sollte also das zweite >
dargestellt werden. Das passiert nicht, weil Browser keine
richtigen[tm] SGML-Parser sind, sondern gewisse Fehler einfach
hinnehmen.

Grüße,
 CK