¿Existe algún estándar, de facto o de otro tipo, para los documentos XML? Por ejemplo, ¿cuál es la "mejor" forma de escribir una etiqueta?
<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />
Del mismo modo, si tengo un valor enumerado para un atributo que es mejor
<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
xml
coding-style
naming-conventions
tpower
fuente
fuente
Respuestas:
Sospecho que los valores más comunes serían camelCased, es decir
En particular, los espacios causan algunos fallos si se mezclan con generadores de código (es decir, para [des] serializar xml a objetos), ya que no muchos lenguajes permiten enumeraciones con espacios (exigiendo un mapeo entre los dos).
fuente
Reglas de nombres XML
Los elementos XML deben seguir estas reglas de nomenclatura:
Se puede usar cualquier nombre, no se reservan palabras (excepto xml).
Mejores prácticas de nomenclatura
Estilos de nombres
No hay estilos de nomenclatura definidos para elementos XML. Pero aquí hay algunos de uso común:
referencia http://www.w3schools.com/xml/xml_elements.asp
fuente
Para mí, es como discutir el estilo de código de un lenguaje de programación: algunos defenderán un estilo, otros defenderán una alternativa. El único consenso que vi es: "¡Elija un estilo y sea coherente"!
Solo noto que muchos dialectos XML solo usan nombres en minúsculas (SVG, Ant, XHTML ...).
No obtengo la regla "sin espacios en los valores de los atributos". De alguna manera, envía al debate "¿qué poner en atributos y qué poner como texto?".
Quizás estos no sean los mejores ejemplos, pero hay algunos formatos XML bien conocidos que usan espacios en los atributos:
No entiendo completamente los argumentos en contra de la práctica (parece aplicarse solo a algunos usos) pero es legal al menos, y se usa bastante ampliamente. Con inconvenientes, aparentemente.
Ah, y no necesitas un espacio antes de la barra de cierre automático. :-)
fuente
Yo prefiero TitleCase para los nombres de los elementos y camelCase para los atributos. No hay espacios para ninguno.
Aparte, hice una búsqueda rápida de Mejores prácticas en XML y encontré este enlace bastante interesante: Esquemas XML: Mejores prácticas .
fuente
Yo tendería a favorecer las etiquetas en minúsculas o en mayúsculas y, dado que los atributos normalmente deberían reflejar valores de datos, no contenido, me ceñiría a un valor que podría usarse como nombre de variable en cualquier plataforma / idioma que pueda estar interesado, es decir, evitar espacios pero el otro dos formas podrían estar bien
fuente
Es subjetivo, pero si hay dos palabras en una etiqueta de elemento, la legibilidad se puede mejorar agregando un guión bajo entre las palabras (p
<my_tag>
. Ej. ) En lugar de usar ningún separador. Referencia: http://www.w3schools.com/xml/xml_elements.asp . Entonces, de acuerdo con w3schools, la respuesta sería:El valor no necesita usar un guión bajo o un separador, ya que se le permiten espacios en los valores de los atributos, pero no en los nombres de las etiquetas de los elementos.
fuente
Muchos dialectos XML centrados en documentos utilizan el latín básico en minúsculas y el guión. Tiendo a ir con eso.
Los generadores de código que mapean XML directamente a identificadores de lenguaje de programación son frágiles y (con la excepción de la serialización de objetos ingenuos, como XAML) deben evitarse en formatos de documentos portátiles; para una mejor reutilización y longevidad de la información, el XML debe intentar coincidir con el dominio, no con la implementación.
fuente
rss es probablemente uno de los esquemas XML más consumidos del mundo y está basado en camello.
Spec está aquí: http://cyber.law.harvard.edu/rss/rss.html
Por supuesto, no tiene atributos de nodo en el esquema, pero todos los nombres de elementos de nodo están basados en camello. Por ejemplo:
lastBuildDate manageEditor pubDate
fuente
Normalmente alineo la convención de nomenclatura XML con la misma convención de nomenclatura en otras partes del código. La razón es que cuando cargo el XML en Object, sus atributos y nombres de elementos se pueden referir como la misma convención de nomenclatura que se usa actualmente en el proyecto.
Por ejemplo, si su javascript usa camelCase entonces su XML usa camelCase también.
fuente
Microsoft adopta dos convenciones:
Para la configuración , Microsoft usa camelCase . Mire el archivo de configuración de Visual Studio. Para VS2013, se almacena en:
C: \ Archivos de programa (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ IDE \ devenv.exe.config
Ejemplo:
Ejemplo:
fuente
No hay ninguna recomendación explícita. Basado en otra recomendación del W3C, la de XHTML , he optado por minúsculas:
fuente
Reglas de nombres XML
Los elementos XML deben seguir estas reglas de nomenclatura:
Fuente: W3 School
fuente
He estado buscando mucho un buen enfoque, también leyendo este hilo y algunos otros y votaría por usar guiones .
Se utilizan ampliamente en ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA ) que se pueden ver en muchos códigos fuente y, por lo tanto, son comunes. Como ya se señaló aquí, ciertamente están permitidos, lo que también se explica aquí: Usando - en el nombre del elemento XML
También como beneficio adicional: al escribir HTML en combinación con CSS, a menudo tiene clases cuyos nombres también usan guiones como separadores de forma predeterminada. Ahora, si tiene etiquetas personalizadas que usan clases CSS o atributos personalizados para etiquetas que usan clases CSS, entonces algo como:
<custom-tag class="some-css-class">
es más consistente y lee, en mi humilde opinión, mucho mejor que:
<customTag class="some-css-class">
fuente