Add Quick-Fix which inserts XML Doc comment template about xmldocinspections HOT 10 CLOSED

So super rad! I'm loving it!

The only thing that could possibly make it more awesome is if you could enable it to optionally add the comments "in this file | in this project | in this solution" as some quick fixes do. I feel bad even suggesting another idea since what you've done is already so massively helpful.

from xmldocinspections.

Implemented on dev branch. Will be available in the next release together with R# 2017.1 support.

from xmldocinspections.

@ulrichb (and @matkoch) I totally get what you're saying.

But it's a classic case of users doing something with your application that you never intended. See, my boss thinks it makes code easier to read simply by inserting XML comments. We're not required to fill out the summary -- we just have to insert the initial XML comment tags (which your plugin does extremely well).

I know. You don't have to tell me. I've tried to convince him otherwise.

Just try to imagine how much extra time we have to spend ensuring that all of our classes, methods, and properties have XML documentation so my boss can have an easier time reading the code. Maybe then you'll understand how excited I'd be if it were somehow easier.

I'll understand if you decide not to implement the feature. It makes sense for the reasons you stated. But, then again, maybe we're not the only team that has to endure such torture.

A few final points: The XML templates generated by your plugin don't have to be implemented. That's a decision left to the developer. I don't think it's unreasonsable to leave it up to the developer if they want to insert XML comments across the entire file/project/solution. Perhaps some would even prefer that for certain workflows.

from xmldocinspections.

OK, I need some more details here. Do you mean an Alt+Enter quick-fix? If yes, what should it do?

from xmldocinspections.

Don't know if this is possible, but when I type /// above a method, it automatically inserts a default comment...

gif demo...

from xmldocinspections.

So you want a quick-fix for "Missing XML Doc" highlightings, which adds the same doc comment template as typing /// before the declaration (as in your GIF). Is this the feature request?

from xmldocinspections.

That would meet my expectations, certainly..

from xmldocinspections.

Released with 1.8.0.

from xmldocinspections.

@alexdresko Regarding your request for a "fix in file/project/solution" feature: I will think about it, but at the moment I tend to do not implement this because the quick fix only generates templates (which have to be edited afterwards). And such a feature possibly misleads people to generate skeleton docs in batch just to silence the warning.

from xmldocinspections.

I know it's a long shot, but I'd still really really really like for this feature to be implemented. It would save me a lot of time.

from xmldocinspections.