Комментарии возможны тэги 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 - это может быть что угодно, пока это уникально.documentation
справа от xmlns:
также может быть любым - это работает так же, как определяется и используется пространство имен android:
XML.
Используя этот формат, любое количество атрибутов может бытьсоздан, например documentation:info
, documentation:translation_notes
и т. д., вместе со значением описания, формат которого совпадает с любым атрибутом XML.
В итоге:
- Добавить
xmls:my_new_namespace
атрибут корневого (верхнего уровня) XML-элемента в файле макета XML.Задайте для его значения уникальную строку - Для любого дочернего элемента XML в файле используйте новое пространство имен и любое следующее слово для определения тегов комментариев, которые игнорируются при компиляции, например,
<TextView my_new_namespace:my_new_doc_property="description" />