re: Don't document your code. Code your documentation. VIEW POST


I always try to use good naming conventions for variables, functions, classes, etc.., but I still believe in docstrings for almost every function/method/class. It takes almost no time, it can help you remain focused, and it will help others quickly see what is happening in the code. I avoid using comments within a function/method, unless it is unavoidably convoluted.


I completely agree with this. It makes it so much easier to add someone new to a project.

code of conduct - report abuse