Me gustaría ingresar algunos comentarios en los archivos XML de diseño, ¿cómo lo haría?
Me gustaría ingresar algunos comentarios en los archivos XML de diseño, ¿cómo lo haría?
Respuestas:
Como dijo otro, los comentarios en XML son así
<!-- this is a comment -->
Tenga en cuenta que pueden abarcar varias 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" />
El Consorcio World Wide Web (W3C) en realidad definió una interfaz de comentarios. La definición dice 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 .
Así que simplemente puede agregar su comentario entre cualquier etiqueta inicial y final. En Eclipse IDE, simplemente escribir <!--
completaría automáticamente el comentario por usted. Luego 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"/>
está mal y dará el siguiente error
Element type "TextView" must be followed by either attribute specifications, ">" or "/>".
ctrl + shift + / Puedes comentar el código.
<!--
<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 -->
Es posible crear atributos personalizados que se pueden utilizar para comentarios / documentación.
En el ejemplo a continuación, documentation:info
se define un atributo, 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 para el nuevo espacio de nombres XML personalizado (de documentation
) y, por lo tanto, es solo una cadena de URI única ; puede ser cualquier cosa siempre que sea única. El documentation
a la derecha de xmlns:
puede ser cualquier cosa: funciona de la misma manera que android:
se define y utiliza el espacio de nombres XML.
Con este formato, se puede crear cualquier número de atributos, como documentation:info
, documentation:translation_notes
etc., junto con un valor de descripción, el formato es el mismo que cualquier atributo XML.
En resumen:
xmls:my_new_namespace
atributo al elemento XML raíz (nivel superior) en el archivo de diseño XML. Establezca su valor en una cadena única<TextView my_new_namespace:my_new_doc_property="description" />
tools:
espacio de nombres especial , que se descarta. (Probablemente no existía cuando se publicó esta respuesta, pero esta página sigue recibiendo nuevos espectadores.)
Si desea comentar Android Studio
simplemente presione:
Ctrl+ /en Windows / Linux
Cmd+ /en Mac.
Esto funciona tanto en archivos XML strings.xml
como en archivos de código como MainActivity.java
.
También puede agregar comentarios presionando Ctrl + shift + / y shift + / para una línea.
Increíblemente, en 2019 con Android Studio 3.3 (no sé la versión exacta, al menos 3.3), es posible usar un comentario de doble barra para xml.
Pero si usa un comentario de barra doble en xml, IDE muestra advertencia.
<?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: ...
.
De la nota de Federico Culloca:
Tampoco puedes usarlos dentro de las etiquetas
Medio; debe colocar 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