[thelist] Coding standards....

Austin Harris austin at dotmail.co.uk
Thu Dec 7 09:42:26 CST 2006


Careful with the comments in the HTML, putting things like "needs to be fixed" etc. can end up being left for the client (and world) to see. (searching for comments in google's code thing can be amusing / spoddy but may surprise as to what gets left in.)

Comments may be more relevant in programming code (JS, PHP, etc.) rather
than HTML but I wouldn't exclude comments from HTML.

I would add to that "Valid (X)HTML" - validate before posting. But a step
towards this would be creating valid and usable templates that others can
use.

My 2 cents,

Jules

On 07/12/06, Chris Ditty <cditty at gmail.com> wrote:
>
> The company that I work for currently does not have any coding
> standards.  No comments, no stylesheet usage, no nothing.  I have
> spoken with my supervisor about this and she has commented that she
> would like to try and get some standards in place.
>
> Can a few of you share your coding standards?  Below is what I
> currently have, but I am drawing a blank on what else needs to be
> said.
>
> Variables should be capitalized accordingly and for easy readability.
>         ie....myVar, dpsLookUp, qry_myApp
>
> Use stylesheets when possible.  It speeds up rendering and makes it
> extremely easier to change colors and other details from one location.
>
> Comment, comment, comment and oh yes, COMMENT!!!!  Comments help you
> and your co-workers know what you were thinking of wen you wrote that
> bit of code.  6 months from now, are you going to remember what you
> did and why you did it?
> --
>
> * * Please support the community that supports you.  * *
> http://evolt.org/help_support_evolt/
>
> For unsubscribe and other options, including the Tip Harvester
> and archives of thelist go to: http://lists.evolt.org
> Workers of the Web, evolt !
>



-- 
Website: http://jrickards.ca
Blog: http://pen-and-ink.ca
E-mail: julian dot rickards at gmail dot com
-- 

* * Please support the community that supports you.  * *
http://evolt.org/help_support_evolt/

For unsubscribe and other options, including the Tip Harvester 
and archives of thelist go to: http://lists.evolt.org 
Workers of the Web, evolt ! 




More information about the thelist mailing list