HTML-Kommentar Konventionen

Question

Ich brauche HTML-Kommentare zu verwenden, um bestimmte Daten zu speichern, aber ich weiß nicht verwenden Kommentar Schemata möchten, die bereits vorhanden sind, wie sie durch Programme wie Dreamweaver<!-- #BeginLibraryItem "/File.lbi" --> oder Startseite erzeugt.

Woher weiß ich, welches Kommentarschema am wenigsten problematisch ist oder zumindest nicht wie andere vorhandene Kommentarkonventionen aussieht?

PS: Mir wurde gesagt, ein Doppel-Hypen "-" in Kommentaren bricht manchmal Rendering.

Answer 1

Sie brauchen mindestens <!-- -->, um einen Kommentar zu haben, und ja, Sie sollten vermeiden, "-" in der Mitte des Kommentars zu haben; die "-" sind die eigentlichen Kommentartrennzeichen. Abgesehen davon können Sie ihm einfach eine beliebige Zeichenfolge voranstellen und ich denke, Sie werden gut sein - z. B. <!--JEREMY_RUDD: -->.

Speichern von Daten in Kommentaren klingt jedoch wie eine suboptimale Idee. Können Sie das näher ausführen? Hast du darüber nachgedacht, ob etwas wie JSON vielleicht nicht passender ist?

Answer 2

Ich habe einen Standard, inspiriert von JSDoc und Javadoc: HTMLDoc.