Comments on: How you can better organize your HTML with comments

By: professional

professional — Sun, 20 Jul 2008 02:23:56 +0000

Hello. I think you are eactly thinking like Sukrat. I really loved the post.

By: Louis

Louis — Fri, 06 Jun 2008 05:31:34 +0000

I find it's extremely rare that developers comment the end of their DIV tags. I thought I was the only one that did this, until I found this article! I actually blogged about this same topic on my own site. Check out the article Do you comment your DIVs?. Thanks.

By: Simon Tsui

Simon Tsui — Mon, 17 Mar 2008 17:17:32 +0000

When I’m working with PHP, instead of HTML comments with , I stick with the PHP comments /* */. The upside to is that these comments “disappear” (PHP comments aren’t outputted) and aren’t seen by anyone else.

By: Wakish

Wakish — Sat, 15 Mar 2008 14:11:16 +0000

I definetly agree with what Mike said! Self-commented variable is better than actually commenting it.

But, viewing things as Dustin is writing, CSS and HTML are not really programming languages and hence needs a different approach. In this context comments are definetly useful! (Though ids and classes should definetly be self-commented )

Yours,
- Wakish -

By: Funzig Web Design Blackburn

Funzig Web Design Blackburn — Fri, 14 Mar 2008 08:31:59 +0000

Good points Dustin. I know exactly what you mean about the open source issue. One of the reasons I like using MODx (opensource CMS) is that it gives you ultimate control over things like code commenting in it’s templating system. I also (mostly) use div commenting on top level structural elements for the reasons you mention.
As for the programming issue, every software development and programming course I’ve ever been on has stressed the importance of commenting. Yes, code should be readable but why not make life easier for yourself and others by commenting?

By: Mike

Mike — Fri, 14 Mar 2008 04:57:18 +0000

“Any programmer worth anything will tell you that code that isnâ€™t commented is messy and unprofessional. ”

I disagree with this 100%. When programming, code should be readable and therefore require no comments. Naming a method updateArticle() is better than naming it u() or something pointless.

The same goes with web programming. Using indenting and also good id/class values helps. I’ve seen a design where there was . That doesn’t tell me anything! Something like makes more sense and helps me navigate code.

The way I and others work is, if it needs a comment, refactor.

By: paul

paul — Thu, 13 Mar 2008 13:24:42 +0000

Great article i never thoguht about doing this, it would probably help my cleanliness a lot. thanks!

By: suraj naik

suraj naik — Thu, 13 Mar 2008 05:31:53 +0000

check out the way how I manage my css..

http://www.cssaglobal.com/demos/html/cssdemo/layout.css