vojtechhabarta / typescript-generator

Generates TypeScript from Java - JSON declarations, REST service client
MIT License
1.14k stars 237 forks source link

Suggestion: ability to add method's comments in SpringApplicationParser #1066

Open softaria-roman opened 1 month ago

softaria-roman commented 1 month ago

As of now there is no ability to add comments on spring controllers and see them in the generated typescrypt file.

I understand that it needs a lot of effort to do it directly - e.g. support real javadocs/java comments.

But is would be easy to add a custom annotation like @TypescryptComment or something and use it within SpringApplicationParser.parseControllerMethod to add comments to the generated typescript methods.

This feature would be very helpful in environments where frontend and backend are developed by different teams.

WDYT?

If you like the idea I would prepare a pull request.