Comments on: Should You Comment Your Code? https://simpleprogrammer.com/comment-code/ Thu, 31 Dec 2020 03:49:35 +0000 hourly 1 https://wordpress.org/?v=7.0 By: jsonmez https://simpleprogrammer.com/comment-code/#comment-2310 Tue, 28 Apr 2015 14:28:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2310 In reply to Travis Alt.

Yes, exactly!

]]>
By: Travis Alt https://simpleprogrammer.com/comment-code/#comment-2309 Mon, 27 Apr 2015 19:36:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2309 I completely agree with everything you said. When I started to learn how to code, I was fortunate enough to be reading a book that taught how to make your variables, methods, functions, etc. have meaning to their name. Following that technique, I rarely used comments as I felt it wasn’t necessary by the way I coded. To this day, I can go back to programs I made years ago and know exactly what is going on without any comments. I have also noticed many good programmers don’t use comments within their code. This ties into another one of your posts about software developers needing a degree. More specifically where you say, “School has become much more about getting a degree-a piece of paper-than it has about actually learning something of value.” In every computer science class I have taken so far, they want you to heavily comment your code. Sometimes to the point where I am spending more time commenting my code, rather than writing code.

]]>
By: zorrohere https://simpleprogrammer.com/comment-code/#comment-2308 Tue, 17 Mar 2015 11:39:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2308 Agree with everything you said.

On the other hand: Try to record your hands in video, it feels odd as if you are not comfortable or your hands jumping nervously. I mean you are not nervous or anything just it creates illusion of that sort.

]]>
By: jsonmez https://simpleprogrammer.com/comment-code/#comment-2307 Mon, 19 Jan 2015 04:45:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2307 In reply to Simone.

Great. Glad you found the video useful. 🙂

]]>
By: Simone https://simpleprogrammer.com/comment-code/#comment-2306 Sun, 18 Jan 2015 10:25:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2306 Thank you John for this post, it really confirms my ideas and thoughts ant commenting. I think I’ll share this video with my co-workers. I have run into some examples of bad comments and I them as example to make others in the team aware of the evilness of comments. Like you said, comments that didn’t change, but the code did, so I was really on the wrong track when I read them. Furthermore I hate all the comment blocks above every public method just because people think that it should be done. It takes up space on my screen, and most of the time it says nothing more than the code already tells me.

]]>
By: Gjermund Bjaanes https://simpleprogrammer.com/comment-code/#comment-2305 Sat, 17 Jan 2015 18:30:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2305 In reply to jsonmez.

Great to hear! :)nnnYou should certainly start a project. A cool technical project where you can share what you learn as you do it. Would be fun to follow.

]]>
By: jsonmez https://simpleprogrammer.com/comment-code/#comment-2304 Sat, 17 Jan 2015 18:27:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2304 In reply to Gjermund Bjaanes.

Totally agree. Love Clean Code. I’ll have to do more technical content. I need to start working on a project. I get to write such little code these days.

]]>
By: Gjermund Bjaanes https://simpleprogrammer.com/comment-code/#comment-2303 Sat, 17 Jan 2015 11:00:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2303 I donu2019t think you stance is extreme at all. I share your view 100%.nnI cringe every time I see a comment, because Iu2019ll never know if the comment has been updated with its surrounding code.nnIts all about that Clean Code <3nI learned all about this from Robert u2018Uncle Bobu2019 Martinu2019s u201cClean Codeu201d. It's such a good book it's not even funny. Every student should HAVE to read that book before graduating and going to a job. It will help them a lot. It really started me out on a great journey.nnAlso: more technical stuff in your videos is something I really want to see.

]]>
By: jsonmez https://simpleprogrammer.com/comment-code/#comment-2302 Fri, 16 Jan 2015 20:19:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2302 In reply to jorge gonzalez.

Yes, definitely. It’s very unfortunate, because many students are taught best practices are to do something that is not actually a best practice.

]]>
By: jorge gonzalez https://simpleprogrammer.com/comment-code/#comment-2301 Wed, 14 Jan 2015 19:28:00 +0000 https://simpleprogrammer.com/?p=10617#comment-2301 In reply to Thomas Henson.

I’m a firm believer that there is a huge brea h between academic CS and what we found in the industry, and in many cases (such as what I had to experience back in college) it comes from teachers who haven’t been involved with the realities of the software development industry for a long time.nnI think this is one of those issues that reflects it greatly.

]]>