[thelist] Coding standards....

Ben Glassman bglassman at gmail.com
Thu Dec 7 13:33:38 CST 2006


I just format them as classes so they validate as CSS. I could just stick
them in a comment block, it don't see how it makes much of a difference.

Ben

On 12/7/06, Julian Rickards <julian.rickards at gmail.com> wrote:
>
> I understand your point but I wouldn't recommend creating CSS classes for
> them because, especially if you are creating documentation for others,
> someone could come along and use those classes in the site and then you
> decide to change the colour scheme, remove these classes and replace them
> with others and mess up someone elses pages.
>
> I would do the same sort of thing but within a comment block in the
> stylesheet file.
>
> Jules
>
> On 07/12/06, Ben Glassman <bglassman at gmail.com> wrote:
> >
> > Just thought of another one. This is something I started doing a few
> > months
> > ago and it saves me a lot of time messing around with photoshop.
> >
> > Whenever I develop a site, I create a set of classes in a "Colors"
> section
> > of my stylesheet that contain the colors used in the site. For example:
> >
> > .blue { color: #2B5353; }
> > .black { color: #000; }
> >
> > etc. etc. (obviously black isn't necessary). Sometimes I put comments
> > after
> > each line saying what the colors are used for. This saves me (and other
> > people) a lot of time opening things in photoshop or taking screenshots
> of
> > sites to find specific colors.
> >
> > Ben
> >
> > On 12/7/06, Eduardo Kienetz <eduardok at gmail.com> wrote:
> > >
> > > On 12/7/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?
> > >
> > > In your PHP files you might find it interesting to use javadoc like
> > > documentation/comments.
> > > http://sourceforge.net/projects/doxygen/
> > > http://en.wikipedia.org/wiki/Doxygen
> > >
> > > --
> > > Eduardo  Bacchi Kienetz
> > > LPI Certified - Level 2
> > > http://www.noticiaslinux.com.br/eduardo/
> > > --
> > >
> > > * * 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 !
> > >
> > --
> >
> > * * 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