feat: verify compilation diagnostics

[yufeih]

A lot of .NET API docs problems are caused by a bad compilation. This PR adds compilation diagnostics logging and abort on compilation errors.

Fixes #2387

[codecov]

Codecov Report

Base: 76.89% // Head: 76.91% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (68ecae6) compared to base (526cd74).
Patch coverage: 92.45% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8397      +/-   ##
==========================================
+ Coverage   76.89%   76.91%   +0.01%     
==========================================
  Files         866      866              
  Lines       30928    30919       -9     
==========================================
- Hits        23781    23780       -1     
+ Misses       7147     7139       -8     

Impacted Files	Coverage Δ
...oft.DocAsCode.Common/Loggers/ConsoleLogListener.cs	80.76% <ø> (-3.85%)	⬇️
src/Microsoft.DocAsCode.Common/Loggers/Logger.cs	67.01% <ø> (ø)
...e.Dotnet/ExtractMetadata/ExtractMetadataOptions.cs	100.00% <ø> (ø)
...de.Dotnet/ExtractMetadata/ExtractMetadataWorker.cs	79.66% <90.00%> (+0.59%)	⬆️
...rc/Microsoft.DocAsCode.Dotnet/CompilationHelper.cs	95.55% <94.33%> (ø)
...actMetadata/RoslynIntermediateMetadataExtractor.cs	100.00% <100.00%> (ø)
....DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs	94.84% <100.00%> (ø)
src/Microsoft.DocAsCode.Common/Git/GitUtility.cs	74.46% <0.00%> (-0.54%)	⬇️
... and 1 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.