Document the Why

Re:Document the Why by stcredzero on Wednesday March 06, 2013 @10:36AM (#5331635)

What does "who" mean in this context?

[ Parent | on HN ]

Re:Document the Why by EvilTerran on Wednesday March 06, 2013 @10:52AM (#5331736)

I'd take that to mean "who wrote the code"; so it's less of a coding style guideline, more coding strategy: "use version control with per-person accounts, so you can tell down the line who made a change".

[ Parent | on HN ]

Re:Document the Why by stcredzero on Wednesday March 06, 2013 @12:22PM (#5332299)

> I'd take that to mean "who wrote the code"

Which would make sense, except that it's the code itself said to indicate this. Or, does he mean for that to be documented in the RCS?

[ Parent | on HN ]

Re:Document the Why by Ensorceled on Wednesday March 06, 2013 @06:48PM (#5334866)

The developer.

I ended up firing a guy because he would not stop littering the code with crap like:

    // 2 lines added by I. Dee Ott Feb 12, 2005
    // increment i
    i++;
    // 1 line removed by I. Dee Ott, Feb 12, 2005
    // i = i + 1;

But also the actor or user role.

    // this function can only be run by admin

Is only true if enforced in some way.

[ Parent | on HN ]