3 ms·
> I get that reading the code is what developers should do, but why not help others and make it easier? Even I add comments so that future me can remember how i
by rewmie 3y ago
> I get that reading the code is what developers should do, but why not help others and make it easier? Even I add comments so that future me can remember how it works.
Comments are a code smell. If the code doesn't make it clear what the application is doing, you need to rewrite it so that it does.
If your project does not have unit tests, that should be your priority. It makes no sense to focus on comments on a project that has no unit tests.
> I remember emitting the idea of building a tool to calculate an opinionated code quality score on irc, I got mocked. If your codebase is low quality either hire people to refactor it or rewrite it.
No. If the code is low quality, it's on you to improve it. It's your personal task.
> Bad codebase don't deserve developers in my view.
The quality of a codebase reflects the quality of the people working on it.
Look at your comment. You're complaining it's low quality and has no unit tests, but what did you brought to the table? A vague comments on adding comments, and complaining that you expect other people should fix it. You're the root cause, not the solution.
- marssaxman 3y ago> If the code doesn't make it clear what the application is doing, you need to rewrite it so that it does. The code can only tell you what the application is doing, but sometimes it is also useful to understand why. Were important lessons learned on the way to this particular implementation?