earloc / TypealizR

Statically typed i18n support for the .NET - ecosystem
MIT License
75 stars 3 forks source link

XML-comments missing / not always formatted, correctly #206

Closed nielsNocore closed 4 months ago

nielsNocore commented 4 months ago

in come cases the added xml comments in the

are not correctly formated: we use some analysers like stylecop, sonarqube and despite the auto-generate tag these analyzers show warnings.

image

due to the use of &lt and n&gt this result in 4 differnent warnings when compiling.

missing xml coments on the generated class.. image

earloc commented 4 months ago

Could you post the messages emitted by the external analyzers?

How would the "compliant" version look in your example?

Might be an easy fix.

nielsNocore commented 4 months ago

hi there, here are the error messages in visual studio image

and image

we also generate some docus using DocFX and due to there warnings we also get warnings from docfx like: image

nielsNocore commented 4 months ago

also in the the typelizedClassSourceGenerator files there are some errors on public methods that do not have a SML comment image and image

earloc commented 4 months ago

Ok, thx. Will have a look into that when I find the time.

Would it also help, if you could opt-out of TypealizR generating those comment? Or would the analyzers then complain about non-documented public members?

earloc commented 4 months ago

ahh, missed the second example 😇. Opting-out would probably not work for you.

nielsNocore commented 4 months ago

no indeed, opoing-out would not work for us 😄

earloc commented 4 months ago

v0.9.6 should arrive, shortly.

Hoping I catched all occurences

earloc commented 4 months ago

@nielsNocore let me know of 0.9.6 fixes all of your issues.

Just reopen this issue if not and provide some details what might be still missing.

nielsNocore commented 4 months ago

@earloc thanks did a try, found some isssues, created a PR #208 to fix this,.

earloc commented 4 months ago

@nielsNocore

v0.9.7-pre01 should arrive soon-ish

earloc commented 4 months ago

https://www.nuget.org/packages/TypealizR/0.9.7-pre0001

@nielsNocore let me know if this is working for you now.

nielsNocore commented 4 months ago

we are getting there 😄 have some remaining issues: the see ref is nog valid now is missing the {} after IStringLocalizer. image and image i think the attribute should be placed after the summary.

and i found a new one: with the resource key: "[Tax]: Net" the following code is generated: image

nielsNocore commented 4 months ago

created a new PR with a proposal: #210.

let me know what you think

earloc commented 4 months ago

Seems ok, thx for the contribution.

The whole "template" - stuff would need a major rewrite (see #65) , so I'm totally fine with whatever you need to do in order to get rid of your issues.

Sadly, the PR-build somehow fails while beginning SonarCloud-Analysis. Always a pita with this thingy 😅.

Having some other code-smells to tackle, which I'm planning to fix by the end of the week. In the mean-time, I could publish another pre-version based on this PRs branch.

nielsNocore commented 4 months ago

i tried version 0.9.7-pre0003, as far as ik can see, al the issues are resolved!

earloc commented 4 months ago

nice. I initiated publish of non-pre version of v0.9.7.

Feel free to come back, if anything else might pop up.

And again, thx for your contribution 👊.

nielsNocore commented 4 months ago

thank you for your help with this. i really like this packages, so keep up the good work! 💪

earloc commented 4 months ago

You're welcome.

Always nice to get in touch with someone benefitting from a certain effort 🙃.

v0.9.9 is out, might perform slightly better (according to SonarCloud, at least) ✌️.