You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@zookeeper.apache.org by "Kezhu Wang (Jira)" <ji...@apache.org> on 2024/12/07 05:56:00 UTC
[jira] [Resolved] (ZOOKEEPER-4880) Generate comments from zookeeper.jute into code
[ https://issues.apache.org/jira/browse/ZOOKEEPER-4880?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kezhu Wang resolved ZOOKEEPER-4880.
-----------------------------------
Fix Version/s: 3.10.0
Resolution: Fixed
Issue resolved by pull request 2206
[https://github.com/apache/zookeeper/pull/2206]
> Generate comments from zookeeper.jute into code
> -----------------------------------------------
>
> Key: ZOOKEEPER-4880
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-4880
> Project: ZooKeeper
> Issue Type: Improvement
> Components: jute
> Reporter: luozongle
> Priority: Minor
> Labels: pull-request-available
> Fix For: 3.10.0
>
> Time Spent: 7.5h
> Remaining Estimate: 0h
>
> 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.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)