Support comments in UI editors (settings and keyboard shortcuts)

[jabacchetta]

I prefer using the UI editor for both settings and keyboard shortcuts. However, I often find myself automatically going into the JSON files because they're packed with comments — for both modified and unmodified settings/keyboard rules (example shown below).

Feature Request

• Support ability to add comments to the UI editors, possibly with an icon next to the setting/keyboard rule (if it has a comment), allowing the comment to be viewed by hovering over the icon.
• Add additional tags that would allow you to further filter the results (e.g. @commented, @modified @commented, @unmodified @commented).

Note

This would also solve a bug where comments in the JSON file are removed (without any indication) when making changes in the UI editor. See #75599.

Example

Here's an example settings.json file that has comments for both modified and unmodified settings:

{
  // Disabling validation prevents errors on syntax constructs that aren't supported by the language
  // service (e.g. proposed features such as the pipeline operator). It also prevents duplicate
  // linting errors (from both ts and eslint). However, it also prevents the editor.showUnused
  // (fading of unused variables) option from working.
  // https://github.com/Microsoft/TypeScript/issues/29293)
  // https://github.com/Microsoft/TypeScript/issues/13408
  "javascript.validate.enable": false,
  "typescript.validate.enable": false,

  // Good for disabling annoying tooltips, but nice for eslint error details.
  // Waiting for ability to customize tooltips or place the tooltips at top/bottom.
  // https://github.com/Microsoft/vscode/issues/65996
  // "editor.hover.enabled": false,
}