Python/Java bad and good code comments examples

Описание: Code and details:

Python/Java bad and good code comments examples

http://blog.softhints.com/python-java...

The golden comment rule:

Comments should be short and expressive. I prefer a few valuable comments instead of hundreds of useless lines. The comments should express the "why" and not the "what". The comment should be easily understandable by another person or even from the author(after some time). Good comments shouldn't outstand the code and shouldn't be use as excuse for not working code

The sins of commenting code:

over-commenting code
lack of comments
update the code but not the comments
misleading/controversy comment
obvious comments
comment just because you are obliged


---------------------------------------------------------------------------------------------------------------------------------------------------------------
Code store

https://bitbucket.org/softhints/

Socials

Facebook:   / 435421910242028  
Facebook:   / softhints  
Twitter:   / softwarehints  


If you really find this channel useful and enjoy the content, you're welcome to support me and this channel with a small donation via PayPal and Bitcoin.

PayPal donation https://www.paypal.me/fantasyan
Bitcoin: 1DBZu6N9JTpRDdc9QChLZnX3v2iVRaQ4ym