Subversion Repositories DevTools

Rev

Go to most recent revision | Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
1293 dpurdie 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 
<HTML
3 
><HEAD
4 
><TITLE
5 
>Code Style Guide</TITLE
6 
><META
7 
NAME="GENERATOR"
8 
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 
REL="HOME"
10 
TITLE="The Codestriker Guide"
11 
HREF="book1.html"><LINK
12 
REL="UP"
13 
TITLE="Hacking"
14 
HREF="c705.html"><LINK
15 
REL="PREVIOUS"
16 
TITLE="Database Schema"
17 
HREF="x771.html"><LINK
18 
REL="NEXT"
19 
TITLE="Troubleshooting"
20 
HREF="c849.html"></HEAD
21 
><BODY
22 
CLASS="SECT1"
23 
BGCOLOR="#FFFFFF"
24 
TEXT="#000000"
25 
LINK="#0000FF"
26 
VLINK="#840084"
27 
ALINK="#0000FF"
28 
><DIV
29 
CLASS="NAVHEADER"
30 
><TABLE
31 
SUMMARY="Header navigation table"
32 
WIDTH="100%"
33 
BORDER="0"
34 
CELLPADDING="0"
35 
CELLSPACING="0"
36 
><TR
37 
><TH
38 
COLSPAN="3"
39 
ALIGN="center"
40 
>The Codestriker Guide: Version 1.9.3</TH
41 
></TR
42 
><TR
43 
><TD
44 
WIDTH="10%"
45 
ALIGN="left"
46 
VALIGN="bottom"
47 
><A
48 
HREF="x771.html"
49 
ACCESSKEY="P"
50 
>Prev</A
51 
></TD
52 
><TD
53 
WIDTH="80%"
54 
ALIGN="center"
55 
VALIGN="bottom"
56 
>Chapter 4. Hacking</TD
57 
><TD
58 
WIDTH="10%"
59 
ALIGN="right"
60 
VALIGN="bottom"
61 
><A
62 
HREF="c849.html"
63 
ACCESSKEY="N"
64 
>Next</A
65 
></TD
66 
></TR
67 
></TABLE
68 
><HR
69 
ALIGN="LEFT"
70 
WIDTH="100%"></DIV
71 
><DIV
72 
CLASS="SECT1"
73 
><H1
74 
CLASS="SECT1"
75 
><A
76 
NAME="AEN830"
77 
>4.3. Code Style Guide</A
78 
></H1
79 
><P
80 
>        <P
81 
></P
82 
><UL
83 
><LI
84 
><P
85 
>	      All comments must be complete sentences. Start with
86 
	      a capital letter, and end with a fullstop.
87 
            </P
88 
></LI
89 
><LI
90 
><P
91 
>	      Function calls should have no extra spaces around the
92 
	      <CODE
93 
CLASS="FUNCTION"
94 
>()</CODE
95 
>, so <CODE
96 
CLASS="FUNCTION"
97 
>function( x
98 
	      )</CODE
99 
>, should be written
100 
	      <CODE
101 
CLASS="FUNCTION"
102 
>function(x)</CODE
103 
>.
104 
	    </P
105 
></LI
106 
><LI
107 
><P
108 
>	      Functions calls with more than one parameter should have
109 
	      spaces after the argument, so
110 
	      <CODE
111 
CLASS="FUNCTION"
112 
>function(x,y,z)</CODE
113 
>, should be
114 
	      <CODE
115 
CLASS="FUNCTION"
116 
>function(x, y, z)</CODE
117 
>.
118 
	    </P
119 
></LI
120 
><LI
121 
><P
122 
>	      Limit line length where possible to 80 characters.
123 
	    </P
124 
></LI
125 
><LI
126 
><P
127 
>	      All SQL statements should use uppercase for SQL
128 
	      keywords, and lowercase for everything else.
129 
	    </P
130 
></LI
131 
></UL
132 
>
133 
      </P
134 
></DIV
135 
><DIV
136 
CLASS="NAVFOOTER"
137 
><HR
138 
ALIGN="LEFT"
139 
WIDTH="100%"><TABLE
140 
SUMMARY="Footer navigation table"
141 
WIDTH="100%"
142 
BORDER="0"
143 
CELLPADDING="0"
144 
CELLSPACING="0"
145 
><TR
146 
><TD
147 
WIDTH="33%"
148 
ALIGN="left"
149 
VALIGN="top"
150 
><A
151 
HREF="x771.html"
152 
ACCESSKEY="P"
153 
>Prev</A
154 
></TD
155 
><TD
156 
WIDTH="34%"
157 
ALIGN="center"
158 
VALIGN="top"
159 
><A
160 
HREF="book1.html"
161 
ACCESSKEY="H"
162 
>Home</A
163 
></TD
164 
><TD
165 
WIDTH="33%"
166 
ALIGN="right"
167 
VALIGN="top"
168 
><A
169 
HREF="c849.html"
170 
ACCESSKEY="N"
171 
>Next</A
172 
></TD
173 
></TR
174 
><TR
175 
><TD
176 
WIDTH="33%"
177 
ALIGN="left"
178 
VALIGN="top"
179 
>Database Schema</TD
180 
><TD
181 
WIDTH="34%"
182 
ALIGN="center"
183 
VALIGN="top"
184 
><A
185 
HREF="c705.html"
186 
ACCESSKEY="U"
187 
>Up</A
188 
></TD
189 
><TD
190 
WIDTH="33%"
191 
ALIGN="right"
192 
VALIGN="top"
193 
>Troubleshooting</TD
194 
></TR
195 
></TABLE
196 
></DIV
197 
></BODY
198 
></HTML
199 
>