[ 2374951 ] Code documentation requested

[HolQue]

It is good practice to document code with code comments.

Taking a look at

https://github.com/test-fullautomation/python-jsonpreprocessor/blob/develop/JsonPreprocessor/CJsonPreprocessor.py

I see a lot of very specific code. But I cannot see any code comments with explanations telling what the code is doing
(especially the regular expressions). The meaning of this code cannot be captured immediately by simply reading this code.

Therefore a code documentation is urgently required.

[test-fullautomation]

Hi Son,
actually I'm disconnected from your code, I only understand small parts.
Only what gives me growing confidence in the code is that Holger and you work very good together with the (regression) test based stabilization.

It would be very nice to have at least the base structure of the code documented that it possible to understand it better.
Example how I made in TML: https://sourcecode.socialcoding.bosch.com/projects/TML/repos/tml_framework/browse/lib/Config/CConfig.py

Basic blocks are always explained, often lines in addition when it is useful for the reader. Sure, this is not perfect, too, but it helps better to understand what is the meaning of the code.
Thank you,
Thomas

[namsonx]

Hello Thomas,

I will add comments to explanation in the code.

Thank you,
Son

[namsonx]

Hello Thomas,

Could you please plan this code documentation task to next release?

Thank you,
Son