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
-
fdgram4866yCode shouldn't be documented. Code should be well-written so that documentation isn't needed.
-
sauronjs2166y@fdgram either write the good code or put the fukin comments.
Since former is mostly not done so **put the fukin comments**. -
sauronjs2166y@fdgram I have never seen a code good enough for the comments to be skipped, including my own.
-
sauronjs2166y@fdgram if you're working in a start up, you never get enough time to design carefully and code. You just design what works, readable to dumbs and scalable enough to work for few years.
In my current company, I sure get enough time and use it good. I document everything I come across. I believe, I get better when I document because it becomes easier to read my own code. Also, I spend less time type checking when I am writing JS code(yes we don't use typescript). Also, autocomplete looks super when you see whole description of functions in popup and don't need to `CTRL + CLICK` to check what the fuck it's actually doing. -
sauronjs2166y@fdgram trust me, you can never learn enough software engineering to skip documentation. Remember the last time when you checked, what are all the parameters of concat do and what does it do in different conditions.
Related Rants
People adding documentation to their code.
rant
wk127