search

soonevel / TechCreate

0 stars 0 forks source link

Add comments #2

Open orangepaydev opened 1 month ago

orangepaydev commented 1 month ago

https://github.com/soonevel/TechCreate/blob/706645e41f3f4131892bc122664848628d57d87a/src/main/java/org/example/Generator.java#L24

A good practice will be to put in some comment about what your method is doing. Look at JavaDoc to find out more.

https://www.baeldung.com/javadoc

Intellij also has a pretty good JavaDoc template generator, look it up.

soonevel commented 1 month ago

Noted with thanks. Added some comments in Generator, Column, and SchemaValidationException. I did not add JavaDoc to Record and FixedLengthParser as I would not want to overcrowd the template file. Please let me know if you think any comments are inappropriate or insufficient, thanks.