Pil0tXia commented on PR #4272: URL: https://github.com/apache/eventmesh/pull/4272#issuecomment-1645774408
@mxsm Thank you for your valuable opinion. For the existing single-line comments in the code, I hope they can be presented in natural language to reduce the time others spend on inspecting the source code. This way, one can more directly understand a relatively complex data structure and its purpose for being used here. For instance, in this picture, the specific meaning of traversing keys and values in nested iterations requires looking at the property definitions of the entity class to understand. However, single-line comments can precisely indicate different levels and directly inform readers about the relationship between these entity classes and the concept of "client group."  By doing so, readers only need to go through the comments to understand the workflow of this handler and to clearly divide sections for retrieval, validation, processing, and response logic. Of course, I will also consider your suggestions to further streamline single-line comments with relatively clear meanings. As for what you mentioned about "class properties", if you are referring to the attributes of entity classes, rest assured that I have hardly added comments for class properties, except for improving the existing ones to better express their purposes. Lastly, I will squash multiple commits into a new branch for the pull request. Thank you for your excellent suggestions. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
