Commenting in Python: Intern Gill vs Code Tendulkar #shorts #coding #ipl

Key Takeaways

I can't even understand my own code what kind of sorcery is this ah the classic case of past Prius is present me it's time you learn the art of commenting commenting what's that commenting is like simply adding notes in your code to explain what's happening it's like leaving breadcrumbs for your future self or others who read your code wait a minute so you're saying that I don't have to be a detective each time that I look at my own code exactly first be concise but informative with your comments a good comment is like a tweet short but to the point this is interesting what's next second don't State the obvious if your code says x equal to X Plus 1 you don't need to comment like increment X by one focus on explaining the why not the how so no obvious comments finally use comment blocks for your sections of code with a specific purpose for example if you have a function that sorts a list add a comment block at the beginning explaining its purpose and any important details thanks code Tendulkar now I can understand my own code that's the spirit Guild