Ich möchte einige Kommentare in die Layout-XML-Dateien eingeben. Wie würde ich das tun?
144
Wie bereits erwähnt, sind die Kommentare in XML wie folgt
<!-- this is a comment -->
Beachten Sie, dass sie sich über mehrere Zeilen erstrecken können
<!--
This is a comment
on multiple lines
-->
Sie können jedoch nicht verschachtelt werden
<!-- This <!-- is a comment --> This is not -->
Sie können sie auch nicht in Tags verwenden
<EditText <!--This is not valid--> android:layout_width="fill_parent" />
Das World Wide Web Consortium (W3C) hat tatsächlich eine Kommentarschnittstelle definiert. Die Definition sagt
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
.Weitere Informationen finden Sie auf der Website developer.android.com .
Sie können Ihren Kommentar also einfach zwischen einem beliebigen Start- und End-Tag einfügen. In der Eclipse-IDE wird durch einfaches Eingeben
<!--
der Kommentar automatisch für Sie vervollständigt. Sie können dann Ihren Kommentartext dazwischen hinzufügen.Beispielsweise:
Der Zweck der spezifischen Erwähnung
in between
besteht darin, dass Sie es nicht in einem Tag verwenden können.Beispielsweise:
ist falsch und gibt folgenden Fehler
quelle
XML-Kommentare beginnen mit
<!--
und enden mit-->
.Beispielsweise:
quelle
Es gibt zwei Möglichkeiten, wie Sie das tun können
Beginnen Sie Ihren Kommentar mit
"<!--"
und beenden Sie Ihren Kommentar mit "-->"
Beispiel
<!-- my comment goes here -->
Markieren Sie den Teil, den Sie kommentieren möchten, und drücken Sie STRG + UMSCHALT + /
quelle
Strg + Umschalt + / Sie können den Code kommentieren.
quelle
quelle
Kommentare INSIDE-Tags möglich
Es ist möglich, benutzerdefinierte Attribute zu erstellen, die für Kommentar- / Dokumentationszwecke verwendet werden können.
Im folgenden Beispiel wird ein
documentation:info
Attribut mit einem Beispielkommentarwert definiert:Beachten Sie, dass dies in diesem Fall
documentation.mycompany.com
nur eine Definition für den neuen benutzerdefinierten XML-Namespace (vondocumentation
) ist und somit nur eine eindeutige URI-Zeichenfolge - es kann alles sein, solange es eindeutig ist. Dasdocumentation
rechts vonxmlns:
kann auch alles sein - dies funktioniert genauso, wie derandroid:
XML-Namespace definiert und verwendet wird.Unter Verwendung dieses Formats kann eine beliebige Anzahl von Attributen erzeugt, wie beispielsweise sein
documentation:info
,documentation:translation_notes
usw., zusammen mit einer Beschreibung Wert, ist das Format das gleiche wie jeder XML - Attribut ist.Zusammenfassend:
xmls:my_new_namespace
dem XML-Stammelement (oberste Ebene) in der XML-Layoutdatei ein Attribut hinzu. Setzen Sie den Wert auf eine eindeutige Zeichenfolge<TextView my_new_namespace:my_new_doc_property="description" />
quelle
tools:
Namespace, der verworfen wird. (Es existierte wahrscheinlich nicht, als diese Antwort veröffentlicht wurde, aber diese Seite erhält weiterhin neue Zuschauer.)Wenn Sie einen Kommentar abgeben möchten,
Android Studio
drücken Sie einfach:Ctrl+ /unter Windows / Linux
Cmd+ /auf dem Mac.
Dies funktioniert sowohl in XML-Dateien
strings.xml
als auch in Codedateien wieMainActivity.java
.quelle
drücke den
und schreibe alles, was du und alles in Kommentaren sein wirst
quelle
Sie können auch einen Kommentar hinzufügen, indem Sie Strg + Umschalt + / und Umschalt + / für eine Zeile drücken.
quelle
Unglaublicherweise ist es 2019 mit Android Studio 3.3 (ich kenne keine genaue Version, mindestens 3.3) möglich, einen doppelten Schrägstrichkommentar für XML zu verwenden.
Wenn Sie jedoch einen doppelten Schrägstrichkommentar in XML verwenden, zeigt die IDE eine Warnung an.
quelle
Unexpected text found in layout file: ...
.Aus Federico Cullocas Notiz:
Meint; Sie müssen den Kommentar oben oder unten in die Datei einfügen. Alle Stellen, an denen Sie wirklich Kommentare hinzufügen möchten, befinden sich mindestens innerhalb des Layout-Tags der obersten Ebene
quelle