plasmon

enjoy a tasty meal and live :)

physics undergrad (among other, evil things)


micolithe
@micolithe

PSA - You will not remember what this function does or how it works six months from now. Write it down.


confusedcharlot
@confusedcharlot

there's gotta be a code comment alignment chart


DecayWTF
@DecayWTF

I like comments in code because I know that whatever they say is wrong if there has been one (1) commit to the file since they were written


plasmon
@plasmon

I prefer comments explain how something works and why someone decides to do something a certain way rather than just comments saying "this function does this." If you properly name a function and write decent documentation you probably won't forget what it does.

Of course, I'm less about prescribing people a certain style, because that's annoying—just write code how you want, and as long as it runs that's good enough.


You must log in to comment.

in reply to @micolithe's post: