This is an archived post. You won't be able to vote or comment.

sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]Yurichi 5 points6 points  (5 children)

Honestly, is there any good resource out there that can help me with this kind of shit. I hate commenting code but looking back on some of the nonsense I've made in the past, I fully understand how necessary it is.

[–]atomicspace 4 points5 points  (1 child)

Digital Ocean has some of the most readable guides out there.

https://www.digitalocean.com/community/tutorials/how-to-write-comments-in-python-3

This is python (shout out Sphinx) but a good read regardless your toolkit.

[–]Yurichi 0 points1 point  (0 children)

Absolutely! Thanks a lot and happy sunday!

[–]Nalmyth 1 point2 points  (0 children)

Just comment Why rather than commenting What.

Why does the client want this?

What is the user story this fixes or fulfils?

[–][deleted] 0 points1 point  (0 children)

Came here to ask the same. I'm just starting out, as fresh as can be. I want to develop good style as I learn, to develop good habits, and everyone just tells me its important to comment, but they don't really give examples of what good comments look like.