Display translations using documentation comments

[lukaskurz]

What type of PR is this ?

Feature

What was added ?

I added two new options for configuration in the pubspec.yaml

...
generate_comments: true
comment_languages: ["en", "de"]

What they do, is adding documentation comments to the getters, containing the translations for it, like this

  /// * en: Hello
  /// * de: Hello in German
  static String get hello => _getText("hello");

The reason for this is, that it then uses these comments in your IDE, like VSCode and you can directly see the content of the translation

The comment_languages key can be used to limit the amount of translations that are put into the comments. If, for example, you have 20 translations, but you only wanna see the translations of your native language and english, you can define it as:

comment_languages: ["en","de"]

And then only translations from these languages are put into the comments.

Where tests added ?

Yes, I added tests to cover the code i modified and added.

I ran all the tests and they were all successful.

[defuncart]

Hi @lukaskurz, thanks for your contribution, this is a great feature indeed!

Could you run dart format . and commit your changes?

Could you also update example/pubspec.yaml

generate_comments: false
comment_languages: []

for those who tend to look at code and not READMEs :)

[lukaskurz]

@defuncart I completely forgot to add the changes you mentioned, sorry it took this long :sweat_smile: