[ZOOKEEPER-4880] Generate comments from zookeeper.jute into code

• Type: Improvement
• Status: Open
• Priority: Trivial
• Resolution: Unresolved
• Component/s: jute
• Labels: pull-request-available
• Assignee: Unassigned
• Reporter: luozongle
• Created: 22/Oct/24 12:52
• Updated: 2 days ago 07:25

Description

When I was learning protobuf, I found that the comments in the proto file would be generated into the code. I think this feature is very useful. I wonder if this feature can be added to zookeeper, because in the process of learning zookeeper, we can directly see the attribute comments of the relevant classes generated by jute, and there is no need to check the meaning of the fields in zookeeper.jute. Although I found that there are not many comments in the zookeeper.jute file, I think it would be helpful to generate the comments into the code.

And I studied javacc and found that javacc supports this feature. We can get the comments in zookeeper.jute through SPECIAL_TOKEN.

If possible, I hope to contribute a PR.

Issue Links

• links to: GitHub Pull Request #2206