Saya ingin memasukkan beberapa komentar ke dalam tata letak file XML, bagaimana saya melakukannya?
Saya ingin memasukkan beberapa komentar ke dalam tata letak file XML, bagaimana saya melakukannya?
Jawaban:
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:
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="fill_parent"
android:layout_height="fill_parent"
android:orientation="vertical"
tools:context=".TicTacToe" >
<!-- This is a comment -->
</LinearLayout>
Tujuan penyebutan khusus in between
adalah karena Anda tidak dapat menggunakannya di dalam tag.
Sebagai contoh:
<TextView
android:text="@string/game_title"
<!-- This is a comment -->
android:layout_height="wrap_content"
android:layout_width="fill_parent"/>
salah dan akan memberikan kesalahan berikut
Element type "TextView" must be followed by either attribute specifications, ">" or "/>".
ctrl + shift + / Anda dapat mengomentari kodenya.
<!--
<View
android:layout_marginTop="@dimen/d10dp"
android:id="@+id/view1"
android:layout_below="@+id/tv_change_password"
android:layout_width="fill_parent"
android:layout_height="1dp"
android:background="#c0c0c0"/>-->
<!-- comment here -->
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:
<RelativeLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:documentation="documentation.mycompany.com"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:id="@+id/relLayoutID"
documentation:info="This is an example comment" >
<TextView
documentation:purpose="Instructions label"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Click here to begin."
android:id="@+id/tvMyLabel"
android:layout_alignParentTop="true"
android:layout_alignParentStart="true"
documentation:info="Another example comment"
documentation:translation_notes="This control should use the fewest characters possible, as space is limited"
/>
</RelativeLayout>
Perhatikan bahwa dalam kasus ini, documentation.mycompany.com
hanya definisi untuk namespace XML kustom baru documentation
, dan karenanya hanya string URI yang unik - itu bisa apa saja asalkan unik. Di documentation
sebelah kanan xmlns:
juga bisa apa saja - ini bekerja dengan cara yang sama seperti android:
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" />
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 suka MainActivity.java
.
Anda juga dapat menambahkan komentar dengan menekan Ctrl + shift + / dan shift + / untuk satu baris.
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.
<?xml version="1.0" encoding="utf-8"?>
<android.support.constraint.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent"
android:layout_height="match_parent">
// this works
/* this works too */
/*
multi line comment
multi line comment
*/
<TextView
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="Hello World! yeah"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintTop_toTopOf="parent" />
</android.support.constraint.ConstraintLayout>
Unexpected text found in layout file: ...
.
Dari catatan Federico Culloca:
Anda juga tidak dapat menggunakannya di dalam tag
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