[Beantwortet] [CV 12 RC9] Kommentar im XML-Editor einfügen

[Mibr85]

Hallo zusammen
ich möchte gern wegen der besseren lesbarkeit im XML-Editor Kommentare wie im Screenshot (Staus-Objekt, Senden-Objekt) einfügen.
Ich finde aber leider keine Möglichkeit hierfür???

[peuter]

Das Hinzufügen von Kommentaren wird vom XML-Editor momentan nicht unterstützt. Das einzubauen würde auch mehr Probleme erzeugen als Nutzen bringen, daher glaube ich nicht, dass das jemals kommen wird.

[Mibr85]

Ok verstanden.
Aber wo kommen da denn die Kommentare her die man da sieht?

[Robosoc]

Ich nehme an, dass diese im CodeEditormodus eingefügt wurden. Teste ich später mal und gebe Dir Bescheid.

Wenn Du es selber auch schon mal prüfen willst, öffne die Config mal im Expertenmodus, so dass Du den Code siehst jnd Suche die Stelle mit dem Kommentar.

Der CodeEditor hat auch eine Suchfunktion...Damit solltest Du es schnell finden können. Z.b. einfach nach dem Text "Senden-Option" suchen.

[Mibr85]

Also im Texteditor kann ich es auch sehen:


welche Syntax beschreibt den im Texteditor den Kommentar?
Das ! oder was anderes?

@peuter
spricht was dagegen die Kommentare über den Texteditor einzufügen und gibt es dabei was zu beachten?

[Robosoc]

Sehr gut, das meinte ich. Danke, dann brauche ich garnicht mehr schauen.

Ein Kommentar wird per

Code: Alles auswählen

<!--

eingeleitet
und mit

Code: Alles auswählen

-->

beendet. Alles dazwischen ist der Kommentar.

Der Kommentar kann sich auch über mehrere Zeilen erstrecken...allerdings ist mir geraden icht klar, wie das dann im XML-Editor (Screenshot in Deinem ersten Beitrag dargestellt wird, den nutze ich nie, ich editiere meine Config immer im Code-Editor)

[starwarsfan]

Hallo miteinander

Ein Kommentar wird per

Code: Alles auswählen

<!--

eingeleitet
und mit

Code: Alles auswählen

-->

beendet. Alles dazwischen ist der Kommentar.

Das ist zwar grundsätzlich richtig, aber dennoch mit Vorsicht zu geniessen! Diverse Parser und Editoren fallen auf die Nase, wenn es innerhalb des Kommentars doppelte Bindestriche hat. Also "--" kann schon problematisch sein. Weiterhin kann es auch Probleme geben, wenn es innerhalb des Kommentars Zeilenumbrüche hat.

Von daher versuche ich bei Kommentaren in XML-Files nach Möglichkeit jeweils die einzelnen Zeilen als Kommentar zu deklarieren, weil damit auch die Formatierung erhalten bleibt. Zeilenumbrüche gibt es in XML eigentlich nur, damit es für "Humans" besser lesbar ist und je nach Parser/Editor werden diese auch innerhalb der Kommentare ignoriert/entfernt:

Code: Alles auswählen

    <!-- Kommentar Zeile 1 -->
    <!-- Kommentar Zeile 2 -->
    <!-- Kommentar Zeile 3 -->

Just my two cents...

[Robosoc]

Ja, sehr guter Hinweis Yves, danke!

Ich hatte mich auch lediglich getraut noch was zum mehrzeiligen Kommentar zu schreiben, weil ich durch Zufall gestern Abend durch eine Paralleldiskussion im Forum auf folgenden DemoCode aufmerksam wurde, in dem ein sehr großer Abschnitt "auskommentiert" ist (ab Zeile 77).

https://github.com/CometVisu/CometVisu/ ... g_2d3d.xml

Deshalb war ich davon ausgegangen, dass es prinzipiell möglich ist...aber wie es dann im XML Editor interpretiert wird , wusste ich dann einfach auch nicht.

[starwarsfan]

Hallo miteinander

...ein sehr großer Abschnitt "auskommentiert" ist (ab Zeile 77).

https://github.com/CometVisu/CometVisu/ ... g_2d3d.xml

Ja genau, gutes Beispiel. Um etwas einfach mal "auszuschalten" ist das völlig ok. Aber im Sinne von Kommentaren im XML, welche man genau dafür verwenden möchte, sollte man etwas vorsichtiger sein. Das fängt schon damit an, wenn bspw. Entwicklungsumgebung A die Einrückung der Kommentare passend zum restlichen Code einrückt, Editor B das jedoch nicht so macht etc. pp.

Wenn man bspw. in IntelliJ diesen Codeblock auskommentieren möchte:

Code: Alles auswählen

        <profile>
            <!-- for JENKINS builds -->
            <id>jenkins</id>

Dann sieht das Resultat hinterher so aus:

Code: Alles auswählen

<!--        <profile>-->
<!--            &lt;!&ndash; for JENKINS builds &ndash;&gt;-->
<!--            <id>jenkins</id>-->

Man beachte, dass der bereits vorhandene Kommentar sauber durch html-Entitäten ersetzt wurde, um das Problem der doppelten Bindestrich innerhalb des Kommentares zu eliminieren.

[peuter]

spricht was dagegen die Kommentare über den Texteditor einzufügen und gibt es dabei was zu beachten?

Da spricht nichts gegen, alles was es zu beachten gäbe wurde hier bereits erwähnt, mehr fällt mir da auch nicht ein. Sowas wie -- in einem Kommentar führt zu einer ungültigen Config-Datei, was Dir aber beide Editoren der CometVisu auch so mitteilen werden. Zeilenumbrüche würde in der Baumansicht des XML-Editors entfernt könntest Du also durchaus benutzen, aber zu lange Kommentare solltest Du vermeiden, weil der XML-Editor die ab eine gewissen Länge abschneidet (nur in der Darstellung, im Code bleiben die natürlich erhalten) und Du damit Dein Ziel die Inhalte durch Kommentare ein wenig zu strukturieren eher nicht erreichst.