Improve error reporting in Razor source generators

[captainsafia]

To provide a better user experience, we should consider the feedback provided in dotnet/sdk#15756 (comment) and dotnet/sdk#15756 (comment) and improve the experience for presenting diagnostics from the Razor source generator.

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

Thanks for contacting us.
We're moving this issue to the Next sprint planning milestone for future evaluation / consideration. We will evaluate the request when we are planning the work for the next milestone. To learn more about what to expect next and how this issue will be handled you can read more about our triage process here.