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
-
@barptad well, I find myself using some external web APIs that can have breaking/major updates sometimes - It happens, it already happened, and at that time when I needed to update the project for the new API I thought "Fuck that would've been easier with comments and better separation of my functions".
+ As a student sometimes I need to explain to people what I did in this or that line - and I definitely can't remember the syntax / action of every function I've used / wrote , and it's worse with time - my first projects were shit, like everyone's first projects, but when you take them out later you wish you made comments, or at least that's what I noticed from me and some of my surroundings.
But you may be true about me confusing Documentation and Comments, I didn't think about that earlier, I'll probably have to. Thanks for the advice ;) -
@endor I'll definitely think more about that when writing comments from now on - thanks for the advice :) !
-
@AmineIzumi I do agree it might be hard in the beginning. However comments can be dangers to, since if you change your logic but forget to update your comments, now you are misleading yourself and others... If you have the time I highly recommend Clean code from Robert C. Martin a great book and can help a lot...
-
Commenting isn't really important if it's a fun, personal, standalone project but if you're working in a team or think you'd use your code later on, it's vital.
I see so many rants about not being able to understand another developer's code or how some people write such shit, but I think with proper documentation a lot of blood could have been left unboiled.
I recommend you get into the habit of leaving comments wherever you have a section of code that you had to think about to write, even in small one-time projects. It's a good trait to have if you ever plan on going further into large scale projects where teams and/or code reusability are necessary. -
@charyas worked on a personal project for a while, used to know the code inside-out (small project), didn't bother leaving any comments.
Went back to work on it after a 6 month break. From that day, I've learned to write my comments. Never again.
It doesn't matter how familiar you are with your (own) code, good comments will save you worlds of trouble and wasted time - especially when you have to figure out the whole logic of some functions from scratch, or why you did things in a certain way.
"I wrote the code, I have to maintain the code, I wont need any comments"
*some months later*
Code comments be like....
HOW. IN THE WORLD. COULD IT BE SO DIFFICULT TO COMMENT THE CODE I WRITE MYSELF ?
After my first project (you know, the "Working project I made for fun long ago" code everyone did once, but when you look at it again it looks like sorcery and there's no way to understand it ?), I decided that I'd comment almost everything I'd do... But...
When I begin a project, it's fiiiine and I do my comments the way they should be... AND THEN, WHEN DIFFICULTIES ARRIVES AND I START TO BE TIRED (ie : always) THEY START TO INCLUDE INSULTS OR WEIRD JOKES ABOUT THE PROGRAMMING LANGUAGE, MOVIES REFERENCES, AND SOMETIMES THEIR LANGUAGE VARIES. (Like, that project you're doing in English and suddenly there's a comment written in French in the middle of that)
Soo, yeah, even if I do comment my shit now, it isn't more helpful, lol. Maybe I should listen to relaxing music when I code err.
Oh, comments. Damn comments. Someday I'll do those correctly. Maybe.
undefined
semi-rant
goddamn comments
comment
commenting
comments