Existe algum padrão, de fato ou não, para documentos XML? Por exemplo, qual é a "melhor" maneira de escrever uma tag?
<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />
Da mesma forma, se eu tiver um valor enumerado para um atributo que é melhor
<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
xml
coding-style
naming-conventions
tpower
fonte
fonte
Respostas:
Eu suspeito que os valores mais comuns seriam camelCased - ou seja,
Em particular, os espaços causam algumas falhas se misturados com geradores de código (ou seja, para [des] serializar xml para objetos), já que muitas linguagens não permitem enums com espaços (exigindo um mapeamento entre os dois).
fonte
Regras de nomenclatura XML
Os elementos XML devem seguir estas regras de nomenclatura:
Qualquer nome pode ser usado, nenhuma palavra é reservada (exceto xml).
Melhores práticas de nomenclatura
Estilos de Nomenclatura
Não há estilos de nomenclatura definidos para elementos XML. Mas aqui estão alguns comumente usados:
referência http://www.w3schools.com/xml/xml_elements.asp
fonte
Para mim, é como discutir o estilo do código para uma linguagem de programação: alguns argumentarão por um estilo, outros defenderão uma alternativa. O único consenso que vi é: "Escolha um estilo e seja consistente"!
Acabei de notar que muitos dialetos XML usam apenas nomes em minúsculas (SVG, Ant, XHTML ...).
Eu não entendo a regra "sem espaços nos valores dos atributos". De alguma forma, remete ao debate "o que colocar em atributos e o que colocar como texto?".
Talvez esses não sejam os melhores exemplos, mas existem alguns formatos XML bem conhecidos usando espaços nos atributos:
Eu não entendo completamente os argumentos contra a prática (parece se aplicar apenas a alguns usos), mas ela é legal, pelo menos, e amplamente usada. Com desvantagens, aparentemente.
Ah, e você não precisa de um espaço antes da barra de fechamento automático. :-)
fonte
Eu prefiro TitleCase para nomes de elementos e camelCase para atributos. Sem espaços para qualquer um.
Como um aparte, fiz uma busca rápida por Best Practices in XML e encontrei este link bastante interessante: XML schemas: Best Practices .
fonte
Eu tenderia a favorecer as tags em minúsculas ou camelcase e, uma vez que os atributos devem normalmente refletir os valores dos dados - não o conteúdo - eu preferiria um valor que poderia ser usado como um nome de variável em qualquer plataforma / idioma de interesse, ou seja, evite espaços, mas o outro duas formas podem estar ok
fonte
É subjetivo, mas se houver duas palavras em uma tag de elemento, a legibilidade pode ser melhorada adicionando um sublinhado entre as palavras (por exemplo
<my_tag>
) em vez de usar nenhum separador. Referência: http://www.w3schools.com/xml/xml_elements.asp . Portanto, de acordo com w3schools, a resposta seria:O valor não precisa usar um sublinhado ou separador, já que são permitidos espaços nos valores dos atributos, mas não nos nomes das tags dos elementos.
fonte
Muitos dialetos XML centrados em documentos usam latim básico em minúsculas e traço. Eu costumo ir com isso.
Os geradores de código que mapeiam XML diretamente para identificadores de linguagem de programação são frágeis e (com exceção da serialização ingênua de objetos, como XAML) devem ser evitados em formatos de documentos portáteis; para melhor reutilização e longevidade das informações, o XML deve tentar corresponder ao domínio, não à implementação.
fonte
rss é provavelmente um dos esquemas xml mais consumidos no mundo e é camelCased.
As especificações estão aqui: http://cyber.law.harvard.edu/rss/rss.html
Concedido, ele não tem atributos de nó no esquema, mas todos os nomes de elementos de nó são camelCased. Por exemplo:
lastBuildDate manageEditor pubDate
fonte
Eu normalmente alinho a convenção de nomenclatura XML com a mesma convenção de nomenclatura em outras partes do código. A razão é que quando eu carrego o XML em Object, seus atributos e nomes de elementos podem ser referidos como a mesma convenção de nomenclatura usada atualmente no projeto.
Por exemplo, se o seu javascript usa camelCase, seu XML também usa camelCase.
fonte
A Microsoft adota duas convenções:
Para configuração , a Microsoft usa camelCase . Observe o arquivo de configuração do Visual Studio. Para VS2013, é armazenado em:
C: \ Arquivos de programas (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ IDE \ devenv.exe.config
Exemplo:
Exemplo:
fonte
Não há recomendação explícita. Com base em outra recomendação do W3C, para XHTML , optei por letras minúsculas:
fonte
Regras de nomenclatura XML
Os elementos XML devem seguir estas regras de nomenclatura:
Fonte: Escola W3
fonte
Tenho procurado muito por uma boa abordagem, também lendo este tópico e alguns outros e votaria a favor do uso de hífens .
Eles são amplamente usados em ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA ), que podem ser vistos em muitos códigos-fonte e, portanto, são comuns. Como já apontado aqui, eles são certamente permitidos, o que também é explicado aqui: Usando - no nome do elemento XML
Também como um benefício colateral: ao escrever HTML em combinação com CSS, você geralmente tem classes cujos nomes usam hifens como separador por padrão também. Agora, se você tiver tags personalizadas que usam classes CSS ou atributos personalizados para tags que usam classes CSS, algo como:
<custom-tag class="some-css-class">
é mais consistente e lê - na minha humilde opinião - muito mais agradável do que:
<customTag class="some-css-class">
fonte