Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
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 -
😩 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 😂
-
BoxMan1549ygood! it's awful working under a system that is inherently complex with no documentation. worst thing ever.
Related Rants
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
undefined
documentation