14
trnktms
4y

When the documentation 3x longer then the actual code (and does not make any sense)

Comments
  • 1
    Actually it makes sense 😂 and quite simple, though I can only assume what item path could be, but the rest is very common generic data access code.
  • 9
    This is one of the reasons comments are not allowed where I work
  • 2
    @danielspaniol Omg no comments?!! If used correctly, comments can save your ass
  • 0
    Why do you use extra lines for the tags? Even the VS autogenerated comment doesn't do that
  • 4
    @DefiniteGoose I kind of agree with with @danielspaniol

    Auto-generated comments (we used ghostdoc) are worthless.

    How can comments save your ass? Comment why you changed the code.

    A recent audit exposed we lost nearly $800,000 in shipping charges. Turned out it was a bug in the code that caused us to under charge shipping on every order (dollar here, $5 there...it added up over a year). Obviously the corporate $%^& hit the fan.
    Long story short, the dev documented why and turned out the changes were from the CEO himself.
    It was funny to see the tone of the emails change from "HEADS WILL ROLL!!" to "Lets work together as a team to better serve the customer and our employees."
Add Comment