luozongle01 commented on PR #2206: URL: https://github.com/apache/zookeeper/pull/2206#issuecomment-2461577162
> @luozongle01 Thank you for your work! > > It might be late, I am sorry for this, but I think we probably should align on how comments from jute should be formatted in generated sources ? I see two approaches. > > 1. Keep it in origin format. > 2. Transfer comments from one format to another. > > I saw this pr is going on the second approach. I am good to unify the generated comment format. But I think it could be challenge, as we should escape between two formats which could make generated comments strange/inaccurate. > > ``` > // /** > // * Some dead comments. > // */ > // > // Things changed. We are going .. > ``` > > Currently, the generated comments blindly strip some special strings. I don't think it is a good thing. > > I suggest we keep it simple and don't touch comment content, this is also a safe path. If we want javadoc style comments, I think it is ok to convert them manually. > @luozongle01 Thank you for your work! > > It might be late, I am sorry for this, but I think we probably should align on how comments from jute should be formatted in generated sources ? I see two approaches. > > 1. Keep it in origin format. > 2. Transfer comments from one format to another. > > I saw this pr is going on the second approach. I am good to unify the generated comment format. But I think it could be challenge, as we should escape between two formats which could make generated comments strange/inaccurate. > > ``` > // /** > // * Some dead comments. > // */ > // > // Things changed. We are going .. > ``` > > Currently, the generated comments blindly strip some special strings. I don't think it is a good thing. > > I suggest we keep it simple and don't touch comment content, this is also a safe path. If we want javadoc style comments, I think it is ok to convert them manually. Thank you very much for your review. I really didn't consider that 😂😂. I will keep the original format output.  However, for the end-of-line comments, should I continue to keep them at the end of the line or is it better to move them above the code? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: notifications-unsubscr...@zookeeper.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
