Saya ingin memasukkan beberapa komentar ke dalam tata letak file XML, bagaimana saya melakukannya?
145
Seperti yang lain katakan, komentar dalam XML seperti ini
<!-- this is a comment -->
Perhatikan bahwa mereka dapat menjangkau beberapa baris
<!--
This is a comment
on multiple lines
-->
Tapi mereka tidak bisa disarangkan
<!-- This <!-- is a comment --> This is not -->
Anda juga tidak dapat menggunakannya di dalam tag
<EditText <!--This is not valid--> android:layout_width="fill_parent" />
Konsorsium World Wide Web (W3C) sebenarnya mendefinisikan antarmuka komentar. Definisi itu mengatakan
all the characters between the starting ' <!--' and ending '-->' form a part of comment content and no lexical check is done on the content of a comment
.Rincian lebih lanjut tersedia di situs developer.android.com .
Jadi, Anda cukup menambahkan komentar di antara tag awal dan akhir. Dalam Eclipse IDE cukup mengetik
<!--
akan otomatis melengkapi komentar untuk Anda. Anda kemudian dapat menambahkan teks komentar di antaranya.Sebagai contoh:
Tujuan penyebutan khusus
in between
adalah karena Anda tidak dapat menggunakannya di dalam tag.Sebagai contoh:
salah dan akan memberikan kesalahan berikut
sumber
Komentar XML dimulai dengan
<!--
dan diakhiri dengan-->
.Sebagai contoh:
sumber
Ada dua cara untuk melakukannya
Mulai komentar Anda dengan
"<!--"
kemudian akhiri komentar Anda dengan "-->"
Contoh
<!-- my comment goes here -->
Sorot bagian yang ingin Anda komentari dan tekan CTRL + SHIFT + /
sumber
ctrl + shift + / Anda dapat mengomentari kodenya.
sumber
sumber
Komentar DALAM tag mungkin
Dimungkinkan untuk membuat atribut khusus yang dapat digunakan untuk tujuan komentar / dokumentasi.
Pada contoh di bawah ini,
documentation:info
atribut didefinisikan, dengan nilai komentar contoh:Perhatikan bahwa dalam kasus ini,
documentation.mycompany.com
hanya definisi untuk namespace XML kustom barudocumentation
, dan karenanya hanya string URI yang unik - itu bisa apa saja asalkan unik. Didocumentation
sebelah kananxmlns:
juga bisa apa saja - ini bekerja dengan cara yang sama sepertiandroid:
XML namespace didefinisikan dan digunakan.Menggunakan format ini, sejumlah atribut dapat dibuat, seperti
documentation:info
,documentation:translation_notes
dll., Bersama dengan nilai deskripsi, formatnya sama dengan atribut XML apa pun.Singkatnya:
xmls:my_new_namespace
atribut ke elemen XML root (tingkat atas) di file tata letak XML. Tetapkan nilainya ke string unik<TextView my_new_namespace:my_new_doc_property="description" />
sumber
tools:
namespace khusus sebagai gantinya, yang tidak dibuang. (Mungkin tidak ada ketika jawaban ini diposting, tetapi halaman ini terus mendapatkan pemirsa baru.)Jika Anda ingin berkomentar
Android Studio
cukup tekan:Ctrl+ /di Windows / Linux
Cmd+ /di Mac.
Ini berfungsi dalam file XML seperti
strings.xml
juga dalam file kode sukaMainActivity.java
.sumber
klik
dan menulis apa pun yang Anda dan semua akan di komentar
sumber
Anda juga dapat menambahkan komentar dengan menekan Ctrl + shift + / dan shift + / untuk satu baris.
sumber
Luar biasa, pada tahun 2019 dengan Android studio 3.3 (saya tidak tahu versi pastinya, setidaknya 3.3), dimungkinkan untuk menggunakan komentar slash ganda untuk xml.
Tetapi jika Anda menggunakan komentar slash ganda dalam xml, IDE menunjukkan peringatan.
sumber
Unexpected text found in layout file: ...
.Dari catatan Federico Culloca:
Cara; Anda harus meletakkan komentar di bagian atas atau bawah file - semua tempat yang Anda ingin tambahkan komentar setidaknya di dalam tag tata letak tingkat atas
sumber