Need a way to communicate translation hints

[Colengms]

Similar to #20 , we would like to be able to provide notes/hints for translators. Perhaps hints could be passed directly to the call to localize() for inclusion in exported xlf files.

One possible approach might be an alternate localize() function which accepts an additional string for notes/hints. i.e. localize_with_hint(key, hint, localizableString, ...stringArgs)

This would seem to require a change to the format of the exported JSON, or perhaps an additional exported file containing a mapping of hints to string keys, which can be read when generating the xlf for export.

[Colengms]

This issue is becoming more critical for us. We would like to use markdown in some cases in which text is localized, and we do not have a way to communicate guidence to our localization team that markdown should be used for those strings. Because nls-dev will regenerate loc export files, there is not a clear way for us to manage adding hint info (to existing fields for that purpose) to that file.

[sana-ajani]

you can pass a key and comment to nls.localize function, like so: https://github.com/microsoft/vscode/blob/595d2b9b916d063aadfc2c1a8c8f6df5b45572a8/src/vs/base/browser/ui/selectBox/selectBoxCustom.ts#L732