Gibt es de facto oder anderweitig einen Standard für XML-Dokumente? Was ist zum Beispiel der "beste" Weg, um ein Tag zu schreiben?
<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />
Ebenso, wenn ich einen Aufzählungswert für ein Attribut habe, das besser ist
<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
xml
coding-style
naming-conventions
tpower
quelle
quelle
Antworten:
Ich vermute, die häufigsten Werte wären camelCased - dh
Insbesondere verursachen die Leerzeichen einige Fehler, wenn sie mit Codegeneratoren gemischt werden (dh um XML in Objekte zu [de] serialisieren), da nicht viele Sprachen Aufzählungen mit Leerzeichen zulassen (was eine Zuordnung zwischen beiden erfordert).
quelle
XML-Namensregeln
XML-Elemente müssen diesen Namensregeln folgen:
Es kann ein beliebiger Name verwendet werden, es sind keine Wörter reserviert (außer XML).
Beste Benennungspraktiken
Stile benennen
Für XML-Elemente sind keine Namensstile definiert. Aber hier sind einige häufig verwendete:
Referenz http://www.w3schools.com/xml/xml_elements.asp
quelle
Für mich ist es wie eine Diskussion über den Codestil für eine Programmiersprache: Einige argumentieren für einen Stil, andere verteidigen eine Alternative. Der einzige Konsens, den ich gesehen habe, ist: "Wähle einen Stil und sei konsequent"!
Ich stelle nur fest, dass viele XML-Dialekte nur Kleinbuchstaben verwenden (SVG, Ant, XHTML ...).
Ich erhalte nicht die Regel "Keine Leerzeichen in Attributwerten". Irgendwie sendet es an die Debatte "was in Attribute und was als Text zu setzen?".
Vielleicht sind dies nicht die besten Beispiele, aber es gibt einige bekannte XML-Formate, die Leerzeichen in Attributen verwenden:
Ich verstehe die Argumente gegen die Praxis nicht vollständig (scheint nur für einige Verwendungen zu gelten), aber sie ist zumindest legal und weit verbreitet. Anscheinend mit Nachteilen.
Oh, und Sie brauchen kein Leerzeichen vor dem Schrägstrich mit automatischer Schließung. :-)
quelle
Ich bevorzuge TitleCase für Elementnamen und camelCase für Attribute. Keine Leerzeichen für beide.
Nebenbei habe ich schnell nach Best Practices in XML gesucht und mir diesen ziemlich interessanten Link ausgedacht: XML-Schemas: Best Practices .
quelle
Ich würde eher Klein- oder Kamelbuchstaben bevorzugen, und da Attribute normalerweise Datenwerte widerspiegeln sollten - nicht Inhalte -, würde ich mich an einen Wert halten, der als Variablenname für jede Plattform / Sprache verwendet werden könnte, dh Leerzeichen, aber die andere Zwei Formen könnten in Ordnung sein
quelle
Es ist subjektiv, aber wenn ein Element-Tag zwei Wörter enthält, kann die Lesbarkeit verbessert werden, indem ein Unterstrich zwischen Wörtern (z. B.
<my_tag>
) hinzugefügt wird, anstatt kein Trennzeichen zu verwenden. Referenz: http://www.w3schools.com/xml/xml_elements.asp . Laut w3schools wäre die Antwort also:Der Wert muss keinen Unterstrich oder Trennzeichen verwenden, da Sie Leerzeichen in Attributwerten, jedoch nicht in Element-Tag-Namen zulassen.
quelle
Viele dokumentenzentrierte XML-Dialekte verwenden lateinisches Kleinbuchstaben und Bindestrich. Ich neige dazu, damit zu gehen.
Codegeneratoren, die XML direkt auf Programmiersprachenkennungen abbilden, sind spröde und sollten (mit Ausnahme der naiven Objektserialisierung wie XAML) in tragbaren Dokumentformaten vermieden werden. Für eine optimale Wiederverwendung und Langlebigkeit der Informationen sollte das XML versuchen, mit der Domäne und nicht mit der Implementierung übereinzustimmen.
quelle
rss ist wahrscheinlich eines der am häufigsten verwendeten XML-Schemas der Welt und es ist camelCased.
Spezifikation ist hier: http://cyber.law.harvard.edu/rss/rss.html
Zugegeben, es enthält keine Knotenattribute im Schema, aber alle Knotenelementnamen sind camelCased. Beispielsweise:
lastBuildDate ManagingEditor pubDate
quelle
Normalerweise richte ich die XML-Namenskonvention mit der gleichen Namenskonvention in anderen Teilen des Codes aus. Der Grund dafür ist, dass beim Laden des XML in Object die Attribute und Elementnamen als dieselbe Namenskonvention bezeichnet werden können, die derzeit im Projekt verwendet wird.
Wenn Ihr Javascript beispielsweise camelCase verwendet, verwendet Ihr XML auch camelCase.
quelle
Microsoft unterstützt zwei Konventionen:
Für die Konfiguration verwendet Microsoft camelCase . Sehen Sie sich die Visual Studio-Konfigurationsdatei an. Für VS2013 wird es gespeichert in:
C: \ Programme (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ IDE \ devenv.exe.config
Beispiel:
Beispiel:
quelle
Es gibt keine explizite Empfehlung. Aufgrund einer anderen Empfehlung von W3C, der für XHTML , habe ich mich für Kleinbuchstaben entschieden:
quelle
XML-Namensregeln
XML-Elemente müssen diesen Namensregeln folgen:
Quelle: W3 School
quelle
Ich habe viel nach einem guten Ansatz gesucht, auch diesen Thread und einige andere gelesen und würde für die Verwendung von Bindestrichen stimmen .
Sie werden häufig in ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA ) verwendet, das in vielen Quellcodes zu finden ist und daher häufig vorkommt. Wie hier bereits erwähnt, sind sie sicherlich erlaubt, was auch hier erklärt wird: Verwenden von - in XML-Elementnamen
Auch als Nebeneffekt: Wenn Sie HTML in Kombination mit CSS schreiben, haben Sie häufig Klassen, deren Namen standardmäßig auch Bindestriche als Trennzeichen verwenden. Wenn Sie nun benutzerdefinierte Tags haben, die CSS-Klassen verwenden, oder benutzerdefinierte Attribute für Tags, die CSS-Klassen verwenden, dann etwas wie:
<custom-tag class="some-css-class">
ist konsistenter und liest sich - meiner bescheidenen Meinung nach - viel schöner als:
<customTag class="some-css-class">
quelle