Tek-Tips is the largest IT community on the Internet today!
Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!
-
Congratulations biv343 on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!
Clean Code 1
- Thread starter gwillr
- Start date
dwarfthrower
Programmer
Simplicity is elegance. There are several hundred cat-skinning methods. The one that involves the fewest cuts gives the best pelt.
Never be afraid to share your dreams with the world.
There's nothing the world loves more than the taste of really sweet dreams.
Check out Tek-Tips Australia New Zealand forum1155
Never be afraid to share your dreams with the world.
There's nothing the world loves more than the taste of really sweet dreams.
gwrobar, I guess i'd have to say reducing redundant tags when possible.
____________________________________
Just Imagine.
____________________________________
Just Imagine.
- Thread starter
- #4
I would say something compatible with one of the w3c standards. My favorite is XHTML but even the others are ok. I like all my tags closed, my code to look indented and have as much as possible in the CSS. I don't neccessarily mean complete design but fonts, backgrounds etc.
-
1
- #6
Definately move styles into a style sheet and link it in (has the side effect of allowing this to be cached which may lead to some minor performance boosts if you reuse the style sheet).
I tend to move the javascript (from the <head> section of the document) into an external js file once I am in "tidying up mode".
Usually I remove client-side html comments and move them server-side (so they are not seen by a view source). Of course this is not always possible (for instance you only have a simple HTML hosting solution available).
Ideally the HTML code left on the page should be just simple tags (I try to avoid tables as much as possible now) and I tend to do a little indenting to make it more obvious what "blocks" of code are related.
Regarding tidying up Javascript code - I put comments above every function (describing it's intended purpose), and simplify the control structures (adding redundant {} pairs to make it 100% obvious what sits where). I look at any javascript that might contain "tight loops" and see if there are changes I can make to reduce the amount of processing... here is an example:
This is not optimal:
This is more optimal:
As you have already heard, there are many ways to do "code cleanup". It's always good to have a corporate code standard to use as a baseline as well.
Jeff
I tend to move the javascript (from the <head> section of the document) into an external js file once I am in "tidying up mode".
Usually I remove client-side html comments and move them server-side (so they are not seen by a view source). Of course this is not always possible (for instance you only have a simple HTML hosting solution available).
Ideally the HTML code left on the page should be just simple tags (I try to avoid tables as much as possible now) and I tend to do a little indenting to make it more obvious what "blocks" of code are related.
Regarding tidying up Javascript code - I put comments above every function (describing it's intended purpose), and simplify the control structures (adding redundant {} pairs to make it 100% obvious what sits where). I look at any javascript that might contain "tight loops" and see if there are changes I can make to reduce the amount of processing... here is an example:
This is not optimal:
Code:
for (var loop = 0; loop < 100; loop++)
{
document.write(loop);
}This is more optimal:
Code:
var _html = "";
for (var loop = 0; loop < 100; loop++)
{
html += loop.toString(10);
}
document.write(loop);As you have already heard, there are many ways to do "code cleanup". It's always good to have a corporate code standard to use as a baseline as well.
Jeff
- Status
Similar threads
- Locked
- Question
- Locked
- Question