Tôi muốn nhập một số nhận xét vào các tệp XML bố cục, tôi sẽ làm như thế nào?
Tôi muốn nhập một số nhận xét vào các tệp XML bố cục, tôi sẽ làm như thế nào?
Câu trả lời:
Như đã nói, nhận xét trong XML là như thế này
<!-- this is a comment -->
Lưu ý rằng chúng có thể trải dài trên nhiều dòng
<!--
This is a comment
on multiple lines
-->
Nhưng chúng không thể được lồng
<!-- This <!-- is a comment --> This is not -->
Ngoài ra, bạn không thể sử dụng chúng trong các thẻ
<EditText <!--This is not valid--> android:layout_width="fill_parent" />
World Wide Web Consortium (W3C) thực sự đã xác định một giao diện bình luận. Định nghĩa nói 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
.
Thêm chi tiết có sẵn trên trang web developer.android.com .
Vì vậy, bạn chỉ cần thêm nhận xét của mình vào giữa bất kỳ thẻ bắt đầu và kết thúc. Trong IDE Eclipse chỉ cần gõ <!--
sẽ tự động hoàn thành nhận xét cho bạn. Sau đó, bạn có thể thêm văn bản nhận xét của bạn ở giữa.
Ví dụ:
<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>
Mục đích đề cập cụ thể in between
là vì bạn không thể sử dụng nó trong thẻ.
Ví dụ:
<TextView
android:text="@string/game_title"
<!-- This is a comment -->
android:layout_height="wrap_content"
android:layout_width="fill_parent"/>
là sai và sẽ đưa ra lỗi sau
Element type "TextView" must be followed by either attribute specifications, ">" or "/>".
ctrl + shift + / Bạn có thể nhận xét mã.
<!--
<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 -->
Có thể tạo các thuộc tính tùy chỉnh có thể được sử dụng cho mục đích bình luận / tài liệu.
Trong ví dụ dưới đây, một documentation:info
thuộc tính được xác định, với giá trị nhận xét mẫu:
<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>
Lưu ý rằng trong trường hợp này, documentation.mycompany.com
chỉ là một định nghĩa cho không gian tên XML tùy chỉnh mới documentation
và do đó chỉ là một chuỗi URI duy nhất - nó có thể là bất cứ thứ gì miễn là nó là duy nhất. Bên documentation
phải của xmlns:
cũng có thể là bất cứ điều gì - điều này hoạt động giống như cách mà android:
không gian tên XML được định nghĩa và sử dụng.
Sử dụng định dạng này, bất kỳ số lượng thuộc tính nào cũng có thể được tạo, chẳng hạn như documentation:info
, documentation:translation_notes
v.v., cùng với giá trị mô tả, định dạng giống với bất kỳ thuộc tính XML nào.
Tóm tắt:
xmls:my_new_namespace
thuộc tính cho phần tử XML gốc (cấp cao nhất) trong tệp bố cục XML. Đặt giá trị của nó thành một chuỗi duy nhất<TextView my_new_namespace:my_new_doc_property="description" />
tools:
Thay vào đó, hãy xem xét sử dụng không gian tên đặc biệt để loại bỏ. (Có lẽ nó không tồn tại khi câu trả lời này được đăng, nhưng trang này tiếp tục có người xem mới.)
Nếu bạn muốn bình luận Android Studio
chỉ cần nhấn:
Ctrl+ /trên Windows / Linux
Cmd+ /trên máy Mac.
Điều này hoạt động trong các tệp XML strings.xml
như cũng như trong các tệp mã như MainActivity.java
.
bạn cũng có thể thêm nhận xét bằng cách nhấn Ctrl + shift + / và shift + / cho một dòng.
Không thể tin được, vào năm 2019 với Android studio 3.3 (tôi không biết phiên bản chính xác, ít nhất là 3,3), có thể sử dụng nhận xét gạch chéo kép cho xml.
Nhưng nếu bạn sử dụng nhận xét gạch chéo kép trong xml, IDE sẽ hiển thị cảnh báo.
<?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: ...
.
Từ ghi chú của Federico Culloca:
Ngoài ra, bạn không thể sử dụng chúng trong các thẻ
Có nghĩa; bạn phải đặt nhận xét ở trên cùng hoặc dưới cùng của tệp - tất cả các vị trí bạn thực sự muốn thêm nhận xét ít nhất là trong thẻ bố cục cấp cao nhất