Enable view of rendered YAML to include JSON schema

[SteveL-MSFT]

Summary of the new feature / enhancement

To help users understand the resulting YAML better (without going to webpage or man page), we could take descriptions of JSON members from the JSON schema and put those as comments into the YAML.

Proposed technical implementation details (optional)

May make sense to have a switch to suppress assuming most people want to see it to explain what properties do but there could be lots of description being emitted.

[michaeltlombardi]

To clarify, this only impacts the YAML view in the terminal - piping, capturing or redirecting the output still gives the normal JSON, correct?

I think this is a really cool feature idea. Especially if it's configurable.

[SteveL-MSFT]

Yes, only for interactive does it make sense to inject the descriptions as comments