我想在布局XML文件中输入一些注释,我该怎么做?
答案 0 :(得分:243)
正如其他人所说,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" />
答案 1 :(得分:35)
万维网联盟(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 "/>".
答案 2 :(得分:19)
XML评论以<!--
开头,以-->
结尾。
例如:
<!-- This is a comment. -->
答案 3 :(得分:6)
<!-- comment here -->
答案 4 :(得分:5)
有两种方法可以做到这一点
使用"<!--"
发表评论,然后以“-->"
示例<!-- my comment goes here -->
突出显示您要评论的部分,然后按 CTRL + SHIFT + /
答案 5 :(得分:5)
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"/>-->
答案 6 :(得分:4)
如果您想在Android Studio
发表评论,只需按:
Ctrl + /
Mac上的Cmd + / 。
这适用于strings.xml
等XML文件以及MainActivity.java
等代码文件。
答案 7 :(得分:2)
可以创建可用于评论/记录目的的自定义属性。
在下面的示例中,定义了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
)的定义,因此只是a unique URI string - 它可以是任何东西,只要它是独一无二的。 documentation
右侧的xmlns:
也可以是任何内容 - 这与定义和使用android:
XML命名空间的方式相同。
使用此格式,可以创建任意数量的属性,例如documentation:info
,documentation:translation_notes
等,以及描述值,格式与任何XML属性相同。
总结:
xmls:my_new_namespace
属性添加到XML布局文件中的根(顶级)XML元素。将其值设置为唯一字符串<TextView my_new_namespace:my_new_doc_property="description" />
答案 8 :(得分:2)
点击
CTRL + SHIFT + /
并写下你的任何内容,并且将在评论中发表意见
答案 9 :(得分:0)
您还可以按Ctrl + shift + /并将+ /换成一行来添加注释。
答案 10 :(得分:0)
令人难以置信的是,在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>
答案 11 :(得分:-3)
来自Federico Culloca的说明:
此外,你不能在标签内使用它们
装置;你必须把评论放在文件的顶部或底部 - 你真正想要添加评论的所有地方至少都在顶级布局标签内