eine Frage zur Syntax von Kommentaren in HTML

[Matthias Scharwies]

Servus!

@@Gunnar Bittersmann

Deiner Kritik an der Seite würde ich mich anschließen.

@JimKnopf

Ja, es gibt dort etwas zu verbessern!

Meine Meinung: In Abschnitt 1 und 2 geht es weitgehend um sehr elementare Dinge. Hier finden sich viele Antworten auf Fragen, die ein Anfänger stellen würde, wenngleich die Erklärungen z.B. bei Attributen auch schon richtig in die Tiefe gehen. Kann man so machen.

Ausgangspunkt war für uns der gedachte Weg eines Anfängers, der zuerst auf der Seite Wie fange ich an? auf das Anfänger-Tutorial stößt:

• HTML/Tutorials/Einstieg
  • Hier werden in 4 Kapiteln anhands einer Beispielseite die grundlegenden HTML-Elemente und Attribute eingeführt und ab Kap. 3 mit CSS gestaltet.
  • Dieses Tutorial beschränkt sich in Vielem auf das wirklich Grundlegende und lässt manches offen.
  • Am Ende gibt es ein Wie geht es weiter? mit Links zu weiteren Tutorials, aber nicht zu HTML/Tutorials. :-(

HTML/Tutorials

soll jetzt die theoretischen Grundlagen erklären.

• HTML/Tutorials/Entstehung_und_Entwicklung enthält einen historischen Überblick und erwähnt z.b. auch XHTMl, was aber noch in einem eigenen Glossar-Artikel beschrieben wird. (zusammenfassen?)
• HTML/Tutorials/Element,_Tag_und_Attribut ist der Grundlagen-Artikel

Meine Meinung: In Abschnitt 1 und 2 geht es weitgehend um sehr elementare Dinge. Hier finden sich viele Antworten auf Fragen, die ein Anfänger stellen würde, wenngleich die Erklärungen z.B. bei Attributen auch schon richtig in die Tiefe gehen. Kann man so machen.

Ja, boolesche Attribute sieht man und irgendwann fragt man sich, warum es dort keinen Wert gibt oder sieht ein required="required"und wundert sich.

Abschnitt 3 richtet sich mit JavaScript und PDF wohl eher an Fortgeschrittene.

Das ist da reinkopiert und sollte entfernt werden!

Abschnitt 4: Kommentare sind für mich wieder etwas sehr elementares, was ich gerne zusammen mit Elementen, Tags und Attributen beschrieben sehen würde.

Ja, in der gekürzten Form (ich würde den Hinweis auf polyglottes HTML wenn dann als Fußnote drinlassen) könnte man es gleich nach den Attributen platzieren.

Die Einschränkungen bei HTML-Kommentaren betreffen allerdings einen sehr speziellen Fall, der Anfänger eher überfordern könnte als ihnen zu helfen.

Andererseits behandelt Abschnitt 1.3 optionale Tags - so gesehen gehört das Zusammenspiel mit Kommentaren inhaltlich schon auf diese Seite. Ich bin unschlüssig.

Ich würde es ganz an den Schluss oder als Mega-Fußnote packen, denn ...

der gute HTMl-Stil ist etwas ganz Grundlegendes, der eigentlich immer wieder implizit erwähnt wird. Hier hat er imho seinen Platz. (Das sollten wir aber wohl noch einmal diskutieren?!) Man sollte aber in der Einleitung noch mehr (oder überhaupt) erwähnen, warum hier theoretische Grundlagen und Empfehlungen zusammen auf einer Seite stehen.

Mein Vorschlag:

• Abschnitt 3 oder wenigstens die anspruchsvollen Teile davon ausgliedern

JavaScript und PDF weg, WAI-ARIA ist eben etwas, womit man zuviel Gutes tut - das wird ja alles von Screenreadern vorgelesen, deshalb sollten Dopplungen wie nav role="naqvigation"ja vermieden werden. Es sollte auch kein onclick-Attribut mehr verwendet werden, Da müsste man doch eine kurze Empfehlung drinbleiben.

• den Titel der Seite ändern in Element, Tag, Attribut und Kommentar

Ich würde lieber einzelne Kapitel des Artikels direkt auf der Übersichtsseite verlinken.

Mir fiel es übrigens schwer, die Erläuterungen zum Thema Kommentare über die systematische Gliederung des Wiki zu finden. Lag vielleicht daran, dass ich ziemlich müde war. In meiner Ungeduld habe ich dann die Suchfunktion genutzt.

Es gibt ja die Seiten Kommentar und Kommentar (Begriffsklärung), die dann auf die jeweiligen Vorkommen verlinken.

Das würde mich sehr interessieren, wie du als Neuling im Wiki suchst und (nicht) findest, bzw. was wir verbessern könnten.

Evtl. könnten wir mal auf Discord diskutieren!

Herzliche Grüße

Matthias Scharwies