CodeIgniter Forums

Full Version: Comments and explanations - how to do it better?
You're currently viewing a stripped down version of our content. View the full version with proper formatting.
Pages: 1 2
My philosophy is this: Forget about that code will be executed by a computer. You write code so it to be read by another human being. Writing code is social communication first of all.

Too much comments, especially about obvious things is not good. A person could easily understand what code does, comments should answer to why. Express your motivation or rationale why are you doing this or that.
(01-14-2016, 06:48 AM)ivantcholakov Wrote: [ -> ]Writing code is social communication first of all.

That is the best explanation I have read yet.

"Writing code is social communication first of all."

That is brilliant - thank you.

Paul
(01-14-2016, 08:11 AM)PaulD Wrote: [ -> ]
(01-14-2016, 06:48 AM)ivantcholakov Wrote: [ -> ]Writing code is social communication first of all.

That is the best explanation I have read yet.

"Writing code is social communication first of all."

That is brilliant - thank you.

Paul

That's a huge stretch, but the general idea is true indeed - if it was only intended to be read by a machine, it would be binary and not human-readable.
Pages: 1 2