[Catalyst]

I'd just add that in addition to indentation (and a good editor will take care of that for you) I'd recommend using meaningful names for objects and classes.

You'll often see things like id="ccf" or class="rbwt" which would be better written as id="CenterColumnFooter" and class="RedBorderWhiteText"

[TJSingleton]

Catalyst, on Nov 30 2006, 07:02 PM, said:

I'd just add that in addition to indentation (and a good editor will take care of that for you) I'd recommend using meaningful names for objects and classes.

You'll often see things like id="ccf" or class="rbwt" which would be better written as id="CenterColumnFooter" and class="RedBorderWhiteText"

Red Border White Text?! What kind of meaning is that? A meaningful name would describe the content, not the appearance. What if you wanted to change to Red Text and White Border? Are you going to go back and change each instance of "RedBorderWhiteText" to "WhiteBorderRedText".

I agree that you should label things meaningfully, I just disagree with the example.

Also, I would suggestnot to use uppercase letters in class names. Instead of "CompanyName", it would be better as "company-name". This will avoid problems with case-sensitivity. [That is gleaned knowledge, but I can't remember where I read that... This article mentions it, but is not this is not the article I am recalling.]

Related: http://www.456bereastreet.com/archive/2005..._tricks_part_1/

[James Mitchell]

Good points there TJ. And I can speak from experience on the case-sensitivity issue, it burned me more than once.

[marcamos]

I've also learned the hard way, but I'm referring to class or id naming schemes. In the past, I would create them as in Catalyst's example (sorry man, I'm not picking on you!), and as mentioned by TJ, I would later change the style; at which point it's descriptive name became a pile of poop.

So one more vote for your class or id describing the content and not the style.

[Catalyst]

Note to self: put more effort into examples

[benbacardi]

On the case-sensitivity issue, I just have a convention that I stick to regardless. If its one word its lower case, more than one and I write it like companyName, first one lowercase others not. I follow the same conventions in my scripting code for function names etc

[marcamos]

benbacardi, on Dec 1 2006, 03:40 AM, said:

On the case-sensitivity issue, I just have a convention that I stick to regardless. If its one word its lower case, more than one and I write it like companyName, first one lowercase others not. I follow the same conventions in my scripting code for function names etc

That is exactly how I do it with my classes and IDs. With my image and document file names, it's always 'image-name.jpg' and 'privacy-policy.php'.

[moojoo]

herkalees, on Nov 30 2006, 08:55 PM, said:

moojoo's way is certainly helpful and thorough, but I'm afraid I don't have the patience to write all that

Thats why I have a snippet set up in skEdit to do it then I can change the id names etc as needed. It come sin very handy if several people need to work on your code and/or a project gets put on hold for a while and you come back to it after a few others. One does not always remember why/how/when they did a specific thing etc. And for me at least it gives me info I need without having to pull the css doc or whatever. Sure takes a few secs to write out but the time it saves is way more. But I am a code nazi so there!

This post has been edited by moojoo: 01 December 2006 - 11:19 AM

[TJSingleton]

I don't do an opening comment, but I have started doing the closing comment which is where it gets harder to identify quickly -- plus you can use find to jump right too it.

<div class="article">
	 <h2>Title</h2>
	 <p>Some content here........</p>
</div>
<!-- end article -->

This has become a recent practice of mine.

I have also started doing my filenames that way. Makes things easy to understand/remember doesn't it?

[sypher]

I do alot of commenting in my php/actionscript files but not really in the html.

I also use the functionName style, i think thats standard practice in most coding languages?

[moojoo]

fooFarghHippySkunk is how it goes.. lowercase then capitalizing every first letter after is the norm.

This post has been edited by moojoo: 04 December 2006 - 01:21 PM

[lwaxhaxnc]

Thanks for finding it and posting it! Once IE7 becomes "the norm", I know I'll be using more of these to my advantage.

[webdesigner12345]

Web Design Philippines develop high quality websites for businesses and individuals at affordable prices.