Existe-t-il une norme, de facto ou autre, pour les documents XML? Par exemple, quelle est la "meilleure" façon d'écrire une balise?
<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />
De même si j'ai une valeur énumérée pour un attribut qui est meilleur
<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
xml
coding-style
naming-conventions
puissance
la source
la source
Réponses:
Je soupçonne que les valeurs les plus courantes seraient camelCased - ie
En particulier, les espaces provoquent quelques problèmes s'ils sont mélangés avec des générateurs de code (c'est-à-dire pour [dé] sérialiser xml en objets), car peu de langages autorisent les énumérations avec des espaces (exigeant un mappage entre les deux).
la source
Règles de dénomination XML
Les éléments XML doivent suivre ces règles de dénomination:
N'importe quel nom peut être utilisé, aucun mot n'est réservé (sauf xml).
Meilleures pratiques de dénomination
Styles de dénomination
Aucun style de dénomination n'est défini pour les éléments XML. Mais en voici quelques-uns couramment utilisés:
référence http://www.w3schools.com/xml/xml_elements.asp
la source
Pour moi, c'est comme discuter du style de code pour un langage de programmation: certains plaideront pour un style, d'autres défendront une alternative. Le seul consensus que j'ai vu est: "Choisissez un style et soyez cohérent"!
Je note juste que beaucoup de dialectes XML utilisent simplement des noms en minuscules (SVG, Ant, XHTML ...).
Je n'obtiens pas la règle "aucun espace dans les valeurs d'attributs". D'une manière ou d'une autre, cela envoie au débat "que mettre en attributs et que mettre en texte?".
Ce ne sont peut-être pas les meilleurs exemples, mais il existe des formats XML bien connus utilisant des espaces dans les attributs:
Je ne comprends pas entièrement les arguments contre la pratique (semblent s'appliquer à certains usages seulement) mais c'est légal au moins, et assez largement utilisé. Avec des inconvénients, apparemment.
Oh, et vous n'avez pas besoin d'espace avant la barre oblique à fermeture automatique. :-)
la source
Je préfère TitleCase pour les noms d'élément et camelCase pour les attributs. Pas de place pour l'un ou l'autre.
En passant, j'ai fait une recherche rapide des meilleures pratiques en XML et j'ai trouvé ce lien plutôt intéressant: schémas XML: meilleures pratiques .
la source
J'aurais tendance à favoriser les balises minuscules ou camelcase et comme les attributs devraient généralement refléter les valeurs des données - pas le contenu - je m'en tiendrai à une valeur qui pourrait être utilisée comme nom de variable dans n'importe quelle plate-forme / langue pourrait être intéressée, c'est-à-dire éviter les espaces mais l'autre deux formes pourraient convenir
la source
C'est subjectif, mais s'il y a deux mots dans une balise d'élément, la lisibilité peut être améliorée en ajoutant un trait de soulignement entre les mots (par exemple
<my_tag>
) au lieu de n'utiliser aucun séparateur. Référence: http://www.w3schools.com/xml/xml_elements.asp . Donc, selon w3schools, la réponse serait:La valeur n'a pas besoin d'utiliser de trait de soulignement ou de séparateur, car vous êtes autorisé à utiliser des espaces dans les valeurs d'attribut mais pas dans les noms de balises d'élément.
la source
De nombreux dialectes XML centrés sur les documents utilisent le latin de base en minuscules et le tiret. J'ai tendance à accepter ça.
Les générateurs de code qui mappent XML directement aux identificateurs de langage de programmation sont fragiles et (à l'exception de la sérialisation d'objets naïfs, tels que XAML) doivent être évités dans les formats de documents portables; pour une meilleure réutilisation et une meilleure longévité des informations, le XML doit essayer de faire correspondre le domaine, pas l'implémentation.
la source
rss est probablement l'un des schémas xml les plus consommés au monde et il est camelCased.
Spec est ici: http://cyber.law.harvard.edu/rss/rss.html
Certes, il n'a aucun attribut de nœud dans le schéma, mais tous les noms d'élément de nœud sont camelCased. Par exemple:
lastBuildDate manageEditor pubDate
la source
J'aligne normalement la convention de dénomination XML avec la même convention de dénomination dans d'autres parties du code. La raison est que lorsque je charge le XML dans Object, ses attributs et noms d'élément peuvent être référencés comme la même convention de dénomination actuellement utilisée dans le projet.
Par exemple, si votre javascript utilise camelCase, votre XML utilise également camelCase.
la source
Microsoft adopte deux conventions:
Pour la configuration , Microsoft utilise camelCase . Regardez le fichier de configuration de Visual Studio. Pour VS2013, il est stocké dans:
C: \ Program Files (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ IDE \ devenv.exe.config
Exemple:
Exemple:
la source
Il n'y a pas de recommandation explicite. Sur la base d'une autre recommandation du W3C, celle pour XHTML , j'ai opté pour les minuscules:
la source
Règles de dénomination XML
Les éléments XML doivent suivre ces règles de dénomination:
Source: École W3
la source
J'ai beaucoup cherché une bonne approche, j'ai également lu ce fil et quelques autres et je voterais pour l' utilisation de tirets .
Ils sont largement utilisés dans ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA ) qui peuvent être vus dans de nombreux codes sources et sont donc courants. Comme déjà souligné ici, ils sont certainement autorisés, ce qui est également expliqué ici: Utilisation de - dans le nom d'élément XML
Autre avantage supplémentaire: lorsque vous écrivez du HTML en combinaison avec CSS, vous avez souvent des classes dont les noms utilisent également des traits d'union comme séparateur par défaut. Maintenant, si vous avez des balises personnalisées qui utilisent des classes CSS ou des attributs personnalisés pour les balises qui utilisent des classes CSS, alors quelque chose comme:
<custom-tag class="some-css-class">
est plus cohérent et se lit - à mon humble avis - bien mieux que:
<customTag class="some-css-class">
la source