Added a script to complete xml documentation with <summary> tags #534
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It will allow us to write comments without the
<summary>
tags - the script completes them when the package is published.I simply don't like the verbosity of XML comments with the
summary
tags, it feels much nicer to write comments without the mess around. And it's not required byTo be honest, I don't like that at all. I don't want to mess the codebase with VisualStudio hacks. The
summary
element is simply totally ugly and it's not required:Unfortunatelly VisualStudio is not one of the sane tools, so I have written this script to mitigate the issues.
I have not removed any
<summary>
tags in the PR, but I'm totally going to do that when it's merged into master (just want to avoid a ton merge conflicts)cc @adamjez @djanosik @tomasherceg What do you think?