Комментарии в Android Layout xml

Как и другие, комментарий в XML выглядит следующим образом

<!-- this is a comment -->

Обратите внимание, что они могут охватывать несколько строк

<!--
    This is a comment
    on multiple lines
-->

Но они не могут быть вложенными

<!-- This <!-- is a comment --> This is not -->

Также вы не можете использовать их внутри тегов

<EditText <!--This is not valid--> android:layout_width="fill_parent" />

Консорциум World Wide Web (W3C) фактически определил интерфейс комментариев. В определении говорится 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.

Более подробная информация доступна на сайте developer.android.com.

Итак, вы можете просто добавить свой комментарий между любыми начальными и конечными тегами. В Eclipse IDE просто введите <!--, чтобы автоматически заполнить комментарий для вас. Затем вы можете добавить текст комментария между ними.

Например:

<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>

Цель особого упоминания in between заключается в том, что вы не можете использовать его внутри тега.

Например:

<TextView 
    android:text="@string/game_title"
    <!-- This is a comment -->
    android:layout_height="wrap_content"
    android:layout_width="fill_parent"/>

неверно и даст следующую ошибку

 Element type "TextView" must be followed by either attribute specifications, ">" or "/>".

Комментарии XML начинаются с <!-- и заканчиваются на -->.

Например:

<!-- This is a comment. -->

<!-- comment here -->

если вы хотите прокомментировать Android Studio. просто нажмите ctrl + /.

Комментарии Возможны теги INSIDE

Возможно создание пользовательских атрибутов, которые могут использоваться для комментариев/документации.

В приведенном ниже примере определяется атрибут documentation:info с примерным значением комментария:

<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>

Обратите внимание, что в этом случае documentation.mycompany.com является просто определением для нового пользовательского пространства имен XML (documentation) и, таким образом, просто уникальный URI string - это может быть что угодно, пока оно уникально. documentation справа от xmlns: также может быть любым - это работает так же, как и используется пространство имен android: XML.

Используя этот формат, можно создать любое количество атрибутов, например documentation:info, documentation:translation_notes и т.д., а также значение описания, формат которого совпадает с любым атрибутом XML.

Вкратце:

• Добавить атрибут xmls:my_new_namespace в XML файл корневого (верхнего уровня) XML в файле макета XML. Установите его значение в уникальную строку
• Под любым дочерним XML-элементом внутри файла используйте новое пространство имен и любое слово, следующее для определения тегов комментариев, которые игнорируются при компиляции, например. <TextView my_new_namespace:my_new_doc_property="description" />

Начните свой комментарий с помощью

 "<!--" the n end your Comment with "-->"

Пример

<-- my goes here -->

От Federico Culloca примечание:

Также вы не можете использовать их внутри тегов

средства; вы должны поместить комментарий в верхнюю или нижнюю часть файла - все те места, где вы действительно хотите добавлять комментарии, по крайней мере, находятся в теге макета верхнего уровня