Subversion Repositories DevTools

Rev

Rev 1295 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Code Style Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Codestriker Guide"
HREF="book1.html"><LINK
REL="UP"
TITLE="Hacking"
HREF="c705.html"><LINK
REL="PREVIOUS"
TITLE="Database Schema"
HREF="x771.html"><LINK
REL="NEXT"
TITLE="Troubleshooting"
HREF="c849.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Codestriker Guide: Version 1.9.3</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x771.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 4. Hacking</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="c849.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="AEN830"
>4.3. Code Style Guide</A
></H1
><P
>        <P
></P
><UL
><LI
><P
>             All comments must be complete sentences. Start with
              a capital letter, and end with a fullstop.
            </P
></LI
><LI
><P
>             Function calls should have no extra spaces around the
              <CODE
CLASS="FUNCTION"
>()</CODE
>, so <CODE
CLASS="FUNCTION"
>function( x
              )</CODE
>, should be written
              <CODE
CLASS="FUNCTION"
>function(x)</CODE
>.
            </P
></LI
><LI
><P
>             Functions calls with more than one parameter should have
              spaces after the argument, so
              <CODE
CLASS="FUNCTION"
>function(x,y,z)</CODE
>, should be
              <CODE
CLASS="FUNCTION"
>function(x, y, z)</CODE
>.
            </P
></LI
><LI
><P
>             Limit line length where possible to 80 characters.
            </P
></LI
><LI
><P
>             All SQL statements should use uppercase for SQL
              keywords, and lowercase for everything else.
            </P
></LI
></UL
>             
      </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x771.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="c849.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Database Schema</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c705.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Troubleshooting</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>