search

DSCKGEC / Resumie

Resumie is an android CV & Portfolio app. Now carry your resume with you wherever you go!
MIT License
11 stars 13 forks source link

Organization and Documentation of the code #31

Open adrishyantee opened 3 years ago

adrishyantee commented 3 years ago

We need proper documentation and organization of the code so that it can be easily understood by newcomers. Make sure that the tasks are executed within functions and comment on how they are working, This is quite a tedious thing to do as you have to go through the whole codebase line by line, but you will learn a lot through this process.

Akshit6828 commented 3 years ago

Hi did you mean we need to add comments in the code for understanding the code? Please correct me if I am wrong!

adrishyantee commented 3 years ago

Hi did you mean we need to add comments in the code for understanding the code? Please correct me if I am wrong!

Yeah, you are right! Adding comments in and around functions, using proper variable names, and whatsoever makes the code look neat.