Comments on: 5 Types of Comments to Avoid Making in Your Code

By: candra

candra — Fri, 18 Mar 2011 15:09:09 +0000

now i know, I am absolete programer

By: The Open Source U » Commenting in your Code

The Open Source U » Commenting in your Code — Sun, 17 Oct 2010 19:55:46 +0000

[...] 5 Types of Comments to Avoid Making in Your Code Categories: Article, Coding Tip, Random Tags: article, Code, codebases, Comments, Funny Comments (0) Trackbacks (0) Leave a comment Trackback [...]

By: Darth Continent

Darth Continent — Fri, 10 Sep 2010 11:03:03 +0000

You also need to include the "invisible programmer" commenter, who doesn't leave a single comment clarifying why they did some wacky implementation of something that may or may not be important to keep. "Oh," you might say, "it's in the specs". WHAT specs??

By: Mams

Mams — Wed, 08 Sep 2010 23:47:12 +0000

You forget the “bitchin’ type” who let comment like “This patch is to fix the piece of crap below”

and the “ascii type” who comment in a form of ascii art.

I would considerer my-self part ascii part bitchin part innapropriate jokes

By: Adel

Adel — Mon, 09 Aug 2010 06:42:21 +0000

I don’t agree with point 5. Most developers dont have the luxury of “fix it now and do not put it off until later”. So long as their is a task management system that mentions that so it does not fall out of scope and is visible to project managers then it should be fine.

These are mainly used not for bug fixes (as they should obviously be fixed) but if a developer notices something quirky happening with their code and they “kind-of” know how to reproduce it, even though they havent desided on the best approach for it.

By: Patrice Stoessel

Patrice Stoessel — Sun, 08 Aug 2010 15:13:39 +0000

about TODO : it shows important things, i don’t think it sould be a comment …
in my code (C/C++), i defined TODO as a macro (taking a message as parameter)

TODO is like a failed assertion meaning “code is not complete”
the actual behavior depends on what we’re doing :

during developpement and test mode, when executed, the behavior of the macro is to throw an exception meaning :
we’re going through some unfinished code, you developper should correct it right now

in production mode (run by customer), the behavior can be customized with a configuration file :
- throw an exception
- pass silently
- any other possibility, depending on the needs of the customer

By: Eric

Eric — Sat, 07 Aug 2010 12:43:19 +0000

The best comments I’ve seen in a source file from the codebase of a (well known) company I worked in were about some Tex-Mex restaurant that a team of developers especially liked. There were comments on the special hot sauce “maison” as well as the address and directions to the restaurant.

Stumbling upon some humor was very pleasant

I like to detect some traces of humor in existing code. I think it makes it more readable
(I’m almost serious: I think it establishes a closer and more human relation with previous developer. You then see his code differently…)

Eric

By: Sam Grover

Sam Grover — Mon, 02 Aug 2010 21:48:34 +0000

6. The Deadline Programmer
I’m doing this because I’ve got a deadline to make. It works. If you don’t like it today or in the future, I don’t give a fuck, unless I’m still on this project.

By: Piotr Jagielski

Piotr Jagielski — Fri, 30 Jul 2010 20:49:21 +0000

Nice I haven’t read Code Complete but Clean Code by Uncle Bob has a good chapter about using comments.

By: Mortaza Doulaty

Mortaza Doulaty — Wed, 28 Jul 2010 08:16:21 +0000

Thanks for sharing. I’m about 10% some day programmer!