varias - Comentarios en Android Layout xml
como comentar codigo en intellij (10)
Me gustaría introducir algunos comentarios en los archivos XML de diseño, ¿cómo lo haría?
Comentarios dentro de etiquetas posibles
Es posible crear atributos personalizados que se pueden usar para fines de comentarios / documentación.
En el siguiente ejemplo, se define un atributo documentation:info , con un valor de comentario de ejemplo:
<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>
Tenga en cuenta que en este caso, documentation.mycompany.com es solo una definición del nuevo espacio de nombres XML personalizado (de documentation ) y, por lo tanto, es solo una cadena URI única , puede ser cualquier cosa, siempre que sea única. La documentation a la derecha de xmlns: también puede ser cualquier cosa, esto funciona de la misma manera que se define y usa el espacio de nombres de android: XML.
Con este formato, se puede crear cualquier cantidad de atributos, como documentation:info , documentation:translation_notes , etc., junto con un valor de descripción, siendo el formato el mismo que cualquier atributo XML.
En resumen:
- Agregue un
xmls:my_new_namespaceal elemento XML raíz (nivel superior) en el archivo de diseño XML. Establezca su valor en una cadena única - Debajo de cualquier elemento XML hijo dentro del archivo, use el nuevo espacio de nombre y cualquier palabra que siga para definir las etiquetas de comentario que se ignoran cuando se compilan, por ejemplo,
<TextView my_new_namespace:my_new_doc_property="description" />
Como otros dijeron, el comentario en XML es así
<!-- this is a comment -->
Tenga en cuenta que pueden abarcar múltiples líneas
<!--
This is a comment
on multiple lines
-->
Pero no pueden ser anidados
<!-- This <!-- is a comment --> This is not -->
Tampoco puedes usarlos dentro de las etiquetas
<EditText <!--This is not valid--> android:layout_width="fill_parent" />
De la nota de Federico Culloca:
Tampoco puedes usarlos dentro de las etiquetas
Medio; tiene que poner el comentario en la parte superior o inferior del archivo; todos los lugares donde realmente desea agregar comentarios están al menos dentro de la etiqueta de diseño de nivel superior
El World Wide Web Consortium (W3C) realmente definió una interfaz de comentarios. La definición dice que 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 .
Más detalles están disponibles en el sitio developer.android.com .
Entonces, simplemente puede agregar su comentario entre cualquier etiqueta inicial y final. En Eclipse IDE simplemente escribiendo <!-- se completará automáticamente el comentario por usted. A continuación, puede agregar el texto de su comentario en el medio.
Por ejemplo:
<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>
El propósito de mencionar específicamente in between es porque no puede usarlo dentro de una etiqueta.
Por ejemplo:
<TextView
android:text="@string/game_title"
<!-- This is a comment -->
android:layout_height="wrap_content"
android:layout_width="fill_parent"/>
es incorrecto y dará el siguiente error
Element type "TextView" must be followed by either attribute specifications, ">" or "/>".
Hay dos formas en que puedes hacer eso
Comience su comentario con
"<!--"y termine su comentario con "-->"Ejemplo
<!-- my comment goes here -->Resalta la parte que deseas comentar y presiona CTRL + MAYÚS + /
Los comentarios XML comienzan con <!-- y terminan con --> .
Por ejemplo:
<!-- This is a comment. -->
Si quiere comentar en Android Studio simplemente presione:
Ctrl + / en Windows / Linux
Cmd + / en Mac.
Esto funciona en archivos XML como strings.xml y en archivos de código como MainActivity.java .
También puede agregar comentarios presionando Ctrl + Shift + / y Shift + / para una línea.
haga clic en el
ctrl + shift + /
y escriba todo lo que sea y todo será en los comentarios
<!-- comment here -->