Formatting xml comments in bad way

[martinaldrin]

Describe the bug
We have started to get comments in xml formatted after we uplift the version of revelc/formatter-maven-plugin.
For more information please see:
#197

[hazendaz]

Is it possible you can look at our tests and submit a pull request with your example showing tests fail? I can work with that and see how to fix while keeping that test long term to prevent future regressions? Sent from my Verizon, Samsung Galaxy smartphone Get Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: martinaldrin ***@***.***> Sent: Thursday, February 6, 2025 5:52:48 AM To: revelc/xml-formatter ***@***.***> Cc: Subscribed ***@***.***> Subject: [revelc/xml-formatter] Formatting xml comments in bad way (Issue revelc/formatter-maven-plugin#194) Describe the bug We have started to get comments in xml formatted after we uplift the version of revelc/formatter-maven-plugin. For more information please see: revelc/xml-formatter#197<#197> — Reply to this email directly, view it on GitHub<#194>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAHODI5OMYYVV6XCM7IEGUL2OM5IBAVCNFSM6AAAAABWTHKLO6VHI2DSMVQWIX3LMV43ASLTON2WKOZSHAZTKMJYG4ZTAMI>. You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[martinaldrin]

Hi,
sorry for late answer.

yes, I can create a PR if it is needed, but I think the problem is that comments are sorted. maybe we could have a flag to disable multi line comment formatting. so we get a similar behaviour as before.

[martinaldrin]

main...martinaldrin:xml-formatter:comment-formatting-issue

[hazendaz]

Hi @martinaldrin You mention the comments are "sorted", I think you meant "formatted". They are never sorted by this plugin. At any rate, that is how modern formatters format the code, it did so correctly. At no point in your example did you state don't format this or that it was 'code'. Typically when you un-comment that, it will format it as code.

While a flag in the codebase to control the behavior of doing so or not doing so can be incredibly beneficial, the reality is its really bad behavior commenting code out like that in code without properly marking it. I don't know off hand if the formatters here, other than java, in this project will adhere to not formatting sections of the code like that or if the example was just one of many.

While I think we can improve behaviour, I don't really see this as a bug in real sense because it formatted exactly the correct way.

[martinaldrin]

Hi, yes I meant "formatted" and not sorted.
It is quite common that people comment out xml instead of removing it or add xml tags as examples.
In eclipse there is support for disabling this feature, so I think it would make sense to be able to disable it here as well.