Hacker News new | ask | show | jobs
by RealDinosaur 2666 days ago
I've seen so many awful standards in my time when it comes to comments. Most of the time it's NIH syndrome, or people who love arbitrary rules. People love to make/follow rules, but comments are too nuanced for absolutes.

I've seen the following... These are all sins in my eyes.

    // This code is the property of Blamo inc.

    // Returns the result
    return result;

    // The name of the entity
    public string Name;

    // author: @author
    // Date last changed: DD/MM/YYYY

    /* 
    / public property Name
    / The name of the Entity
   */
    public string Name { get; set; }
I always try to tell people. DRY also relates to comments.

Also if you are going to supply me with badly written inconsistent style guide that was cooked up internally with no references or reasoning. I'm just going to download a popular one from github, and have all the tooling sorted out-of-the-box. I don't negotiate with terrorists or religious nutcases.

You need a pretty damn good excuse to deviate from industry standards. Most of the time it is personal preferences and a need to be in control.

AKA. I care about standards, I just don't care about your standards.