web-dev-qa-db-fra.com

Commentaires dans Android Layout xml

J'aimerais entrer des commentaires dans les fichiers XML de mise en page. Comment procéderais-je?

androidxml
140
user412317

Comme d'autres l'ont dit, les commentaires en XML sont comme ceci

<!-- this is a comment -->

Notez qu'ils peuvent s'étendre sur plusieurs lignes

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

Mais ils ne peuvent pas être imbriqués

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

Aussi, vous ne pouvez pas les utiliser à l'intérieur des balises

<EditText <!--This is not valid--> Android:layout_width="fill_parent" />
247
Federico klez Culloca

Le World Wide Web Consortium (W3C) a en fait défini une interface de commentaire. La définition dit 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.

Plus de détails sont disponibles sur le site developer.Android.com .

Ainsi, vous pouvez simplement ajouter votre commentaire entre les balises de début et de fin. Dans Eclipse IDE, il vous suffit de taper <!-- pour compléter automatiquement le commentaire. Vous pouvez ensuite ajouter votre texte de commentaire entre les deux.

Par exemple:

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

Le but de mentionner spécifiquement in between est que vous ne pouvez pas l’utiliser dans une balise.

Par exemple:

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

est faux et donnera l'erreur suivante

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

Les commentaires XML commencent par <!-- et se terminent par -->.

Par exemple:

<!-- This is a comment. -->
19
Dan Dyer

Il y a deux façons de faire ça

  1. Commencez votre commentaire avec "<!--" puis terminez votre commentaire avec "-->""

    Exemple <!-- my comment goes here -->

  2. Mettez en surbrillance la partie que vous souhaitez commenter et appuyez sur CTRL + MAJ + /

6
eLi
<!-- comment here -->
6
Wesley Wiser

ctrl + shift + / Vous pouvez commenter le code.

<!--    
     <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"/>-->
5
Yogesh Sarvaiya

Si vous voulez commenter dans Android Studio appuyez simplement sur:

Ctrl + / sous Windows/Linux

Cmd + / sur Mac.

Cela fonctionne dans les fichiers XML tels que strings.xml ainsi que dans les fichiers de code tels que MainActivity.Java.

4
Nabin Khatiwada

clique le

et écrivez tout ce que vous et tout sera dans les commentaires

2
venu46

Commentaires INSIDE tags possibles

Il est possible de créer des attributs personnalisés pouvant être utilisés à des fins de commentaire/documentation.

Dans l'exemple ci-dessous, un attribut documentation:info est défini, avec un exemple de valeur de commentaire:

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

Notez que dans ce cas, documentation.mycompany.com est simplement une définition du nouvel espace de noms XML personnalisé (de documentation), et est donc juste ne chaîne d'URI unique - cela peut être n'importe quoi tant que c'est unique. La documentation à droite du xmlns: peut également être n'importe quoi - cela fonctionne de la même manière que l'espace de nom Android: XML est défini et utilisé.

Ce format permet de créer un nombre quelconque d'attributs, tels que documentation:info, documentation:translation_notes, etc., ainsi qu'une valeur de description, le format étant identique à tout attribut XML.

En résumé:

  • Ajoutez un attribut xmls:my_new_namespace à l'élément XML racine (niveau supérieur) dans le fichier de présentation XML. Définir sa valeur sur une chaîne unique
  • Sous n'importe quel élément XML enfant du fichier, utilisez le nouvel espace de nom et tous les mots suivants pour définir les balises de commentaire ignorées lors de la compilation, par exemple. <TextView my_new_namespace:my_new_doc_property="description" />
2
CJBS

vous pouvez également ajouter un commentaire en appuyant sur Ctrl + Maj +/et Maj +/pour une ligne.

0
user8919158

Incroyablement, en 2019 avec Android studio 3.3 (je ne connais pas la version exacte, au moins la version 3.3), il est possible d’utiliser un commentaire à double barre oblique en xml.

Mais si vous utilisez un commentaire double barre oblique dans xml, IDE affiche un avertissement.

<?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>
0
Stanley Kou