レイアウト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 Consortium(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. -->
できる方法は2つあります
コメントを"<!--"
で開始し、コメントを "-->"
で終了します
例<!-- my comment goes here -->
コメントする部分を強調表示して、CTRL + SHIFT + /を押します
<!-- comment here -->
ctrl + shift + /コードにコメントできます。
<!--
<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"/>-->
Android Studio
にコメントする場合は、次のボタンを押します。
Ctrl + / Windows/Linuxの場合
Cmd + / Macで。
これは、strings.xml
などのXMLファイルとMainActivity.Java
などのコードファイルで機能します。
クリック
何でも書いてください
コメント/文書化の目的に使用できるカスタム属性を作成することができます。
以下の例では、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
は(documentation
の)新しいカスタムXML名前空間の単なる定義であり、したがって 一意のURI文字列 であることに注意してください。一意である限り。 xmlns:
の右側にあるdocumentation
も任意です。これは、Android:
XML名前空間が定義および使用されるのと同じように機能します。
この形式を使用すると、documentation:info
、documentation:translation_notes
などの任意の数の属性を、記述値とともに作成できます。形式はXML属性と同じです。
要約すれば:
xmls:my_new_namespace
属性を、XMLレイアウトファイルのルート(最上位)XML要素に追加します。値を一意の文字列に設定します<TextView my_new_namespace:my_new_doc_property="description" />
ctrl + shift + /およびshift + /を1行押してコメントを追加することもできます。
信じられないほど、2019年にAndroid studio 3.3(少なくとも3.3の正確なバージョンはわかりません)では、xmlにダブルスラッシュコメントを使用できます。
ただし、xmlで二重スラッシュコメントを使用すると、IDEは警告を表示します。
<?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>