16
BoxMan
8y

Architects at the company I'm at rant about, "We don't believe in commenting our code. Good code is self documenting". Nothing about our codebase is "self documenting" FML

Comments
  • 1
    Classes and methods should be documented to explain their requirements like input and return values. But commenting code inside a method is known as an anti pattern.

    If the method is so big that you need to comment throughout what it does then this is usually a sign your method or class is doing too much. Time to refactor and separate out the logic into easier to manage chunks. #SOLID
  • 0
    I agree! but they don't even want that! T.T
  • 2
    😩 not an ideal situation to be in. Let them learn the hard way when they try to upgrade the legacy system with no knowledge of what anything does 😂
  • 0
    Exactly as my previous company.....
  • 0
    good! it's awful working under a system that is inherently complex with no documentation. worst thing ever.
  • 0
    You both have points but like everything there is a balance to be struck.
Add Comment