Android布局xml中的注释
我会在布局XML文件中input一些注释,我该怎么做?
正如其他人所说,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" />
万维网联盟(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网站上find。
因此,您可以简单地在任何开始和结束标记之间添加您的评论。 在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. -->
<!-- comment here -->
INSIDE标签有可能发表评论
可以创build可用于评论/文档目的的自定义属性。
在下面的示例中,定义了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
)的定义,因此只是一个唯一的URIstring – 只要它是唯一的,它可以是任何东西。 xmlns:
右侧的documentation
也可以是任何东西 – 这和android:
XML命名空间的定义和使用方式一样。
使用这种格式,可以创build任意数量的属性,如documentation:info
, documentation:translation_notes
等,以及描述值,格式与任何XML属性相同。
综上所述:
- 将
xmls:my_new_namespace
属性添加到XML布局文件中的根(顶层)XML元素。 将其值设置为唯一的string - 在文件中的任何子XML元素下,使用新的名称空间以及任何后续的字来定义在编译时被忽略的注释标记,例如
<TextView my_new_namespace:my_new_doc_property="description" />
如果你想在Android Studio
发表评论。 只需按ctrl + /
。
开始您的评论
"<!--" the n end your Comment with "-->"
例
<-- my goes here -->
来自Federico Culloca的说明:
你也不能在标签中使用它们
手段; 您必须将注释放在文件的顶部或底部 – 所有您真正想要添加注释的位置至less位于顶层布局标签内