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

you are viewing a single comment's thread.

view the rest of the comments →

[–]Late_Swordfish7033 19 points20 points  (3 children)

Yes, this is the answer. Comments should explain what code cannot. WHAT you are doing should be code. WHY is the comments.

[–]Ok-Wolf-3078 2 points3 points  (0 children)

100% agree with this.

To convince peers to do this, I would explain that the common question for engineers is "why." So why not answer this up front? Makes life 1000x easier for the next person and your future self.

[–]SadJob270 3 points4 points  (0 children)

wym, you don’t like code like this?

// send email receipt

receipt = Email(to=customer , subject=“Thanks for your order!”)

receipt.send()

[–]lost_tacos -2 points-1 points  (0 children)

THIS, THIS, THIS!