Apakah ada standar, de facto atau sebaliknya, untuk dokumen XML? Misalnya, manakah cara "terbaik" untuk menulis tag?
<MyTag />
<myTag />
<mytag />
<my-tag />
<my_tag />
Begitu juga jika saya memiliki nilai yang disebutkan untuk atribut yang lebih baik
<myTag attribute="value one"/>
<myTag attribute="ValueOne"/>
<myTag attribute="value-one"/>
xml
coding-style
naming-conventions
tpower
sumber
sumber
Jawaban:
Saya menduga nilai yang paling umum adalah camelCased - yaitu
Secara khusus, spasi menyebabkan beberapa gangguan jika dicampur dengan generator kode (yaitu untuk [de] membuat serial xml ke objek), karena tidak banyak bahasa yang mengizinkan enum dengan spasi (menuntut pemetaan di antara keduanya).
sumber
Aturan Penamaan XML
Elemen XML harus mengikuti aturan penamaan ini:
Nama apa pun dapat digunakan, tidak ada kata yang dicadangkan (kecuali xml).
Praktik Penamaan Terbaik
Gaya Penamaan
Tidak ada gaya penamaan yang ditentukan untuk elemen XML. Tapi berikut beberapa yang biasa digunakan:
referensi http://www.w3schools.com/xml/xml_elements.asp
sumber
Bagi saya, ini seperti membahas gaya kode untuk bahasa pemrograman: beberapa akan memperdebatkan gaya, yang lain akan mempertahankan alternatif. Satu-satunya konsensus yang saya lihat adalah: "Pilih satu gaya dan konsisten"!
Saya hanya mencatat bahwa banyak dialek XML hanya menggunakan nama huruf kecil (SVG, Ant, XHTML ...).
Saya tidak mendapatkan aturan "tidak ada spasi di nilai atribut". Entah bagaimana, ini mengirimkan ke perdebatan "apa yang harus dimasukkan ke dalam atribut dan apa yang harus dimasukkan sebagai teks?".
Mungkin ini bukan contoh terbaik, tetapi ada beberapa format XML terkenal yang menggunakan spasi di atribut:
Saya tidak sepenuhnya memahami argumen yang menentang praktik tersebut (tampaknya hanya berlaku untuk beberapa penggunaan) tetapi setidaknya legal, dan cukup banyak digunakan. Dengan kekurangan, rupanya.
Oh, dan Anda tidak membutuhkan spasi sebelum garis miring penutup otomatis. :-)
sumber
Saya menyukai TitleCase untuk nama elemen, dan camelCase untuk atribut. Tidak ada spasi untuk keduanya.
Selain itu, saya melakukan pencarian cepat untuk Praktik Terbaik dalam XML, dan menemukan tautan yang agak menarik ini: skema XML: Praktik Terbaik .
sumber
Saya akan cenderung mendukung huruf kecil atau CamelCase tag dan karena atribut harus biasanya mencerminkan nilai-nilai data - tidak puas - saya akan tetap ke nilai yang dapat digunakan sebagai nama variabel di platform apa saja / bahasa mungkin akan tertarik, yaitu menghindari ruang tapi yang lain dua bentuk bisa jadi ok
sumber
Ini subjektif, tetapi jika ada dua kata dalam tag elemen, readibility dapat ditingkatkan dengan menambahkan garis bawah antar kata (misalnya
<my_tag>
) daripada menggunakan tanpa pemisah. Referensi: http://www.w3schools.com/xml/xml_elements.asp . Jadi menurut w3schools jawabannya adalah:Nilai tidak perlu menggunakan garis bawah atau pemisah, karena Anda diperbolehkan spasi dalam nilai atribut tetapi tidak dalam nama tag elemen.
sumber
Banyak dialek XML yang berpusat pada dokumen menggunakan huruf kecil Latin dasar dan tanda hubung. Saya cenderung setuju dengan itu.
Generator kode yang memetakan XML secara langsung ke pengenal bahasa pemrograman sangatlah rapuh, dan (dengan pengecualian serialisasi objek yang naif, seperti XAML) harus dihindari dalam format dokumen portabel; untuk penggunaan kembali terbaik dan umur panjang informasi, XML harus mencoba mencocokkan domainnya, bukan implementasinya.
sumber
rss mungkin salah satu skema xml yang paling banyak dikonsumsi di dunia dan berbasis unta.
Spec ada di sini: http://cyber.law.harvard.edu/rss/rss.html
Memang tidak memiliki atribut node dalam skema, tetapi semua nama elemen node adalah camelCased. Sebagai contoh:
lastBuildDate managingEditor pubDate
sumber
Saya biasanya menyelaraskan konvensi penamaan XML dengan konvensi penamaan yang sama di bagian lain dari kode. Alasannya adalah ketika saya memuat XML ke dalam Objek, atribut dan nama elemennya dapat disebut sebagai konvensi penamaan yang sama yang saat ini digunakan dalam proyek.
Misalnya, jika javascript Anda menggunakan camelCase maka XML Anda juga menggunakan camelCase.
sumber
Microsoft menganut dua konvensi:
Untuk konfigurasi , Microsoft menggunakan camelCase . Lihat file konfigurasi Visual Studio. Untuk VS2013, disimpan di:
C: \ Program Files (x86) \ Microsoft Visual Studio 12.0 \ Common7 \ IDE \ devenv.exe.config
Contoh:
Contoh:
sumber
Tidak ada rekomendasi eksplisit. Berdasarkan rekomendasi lain dari W3C, yang untuk XHTML , saya memilih huruf kecil:
sumber
Aturan Penamaan XML
Elemen XML harus mengikuti aturan penamaan ini:
Sumber: Sekolah W3
sumber
Saya telah banyak mencari pendekatan yang baik, juga membaca utas ini dan beberapa lainnya dan saya akan memilih untuk menggunakan tanda hubung .
Mereka digunakan secara luas di ARIA ( https://developer.mozilla.org/de/docs/Web/Barrierefreiheit/ARIA ) yang dapat dilihat di banyak kode sumber dan oleh karena itu umum. Seperti yang telah ditunjukkan di sini, mereka pasti diperbolehkan, yang juga dijelaskan di sini: Menggunakan - dalam nama elemen XML
Juga sebagai keuntungan sampingan: Saat menulis HTML dalam kombinasi dengan CSS, Anda sering memiliki kelas yang namanya menggunakan tanda hubung sebagai pemisah secara default juga. Sekarang, jika Anda memiliki tag khusus yang menggunakan kelas CSS atau atribut khusus untuk tag yang menggunakan kelas CSS, maka sesuatu seperti:
<custom-tag class="some-css-class">
lebih konsisten dan membaca - menurut pendapat saya - jauh lebih bagus daripada:
<customTag class="some-css-class">
sumber