[r175]: site / standards.html Maximize Restore History

Download this file

standards.html    67 lines (65 with data), 3.1 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>YaBB 3 - Open source forum software</title>
<link type="text/css" rel="stylesheet" href="site.css" />
</head>
<body>
<div id="header">
YaBB 3
<span class="subheader">open source forum software</span>
</div>
<div id="menu">
<ul>
<li><a href="index.html">Home</a></li>
<li class="curpage"><a href="standards.html">Coding Standards</a></li>
<li><a href="roadmap.html">Project Roadmap</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="source.html">Browse SVN</a></li>
<li><a href="https://sourceforge.net/pm/?group_id=9008">Task Tracker</a></li>
<li><a href="http://www.yabbforum.com/team.php">Team</a></li>
</ul>
</div>
<div id="content">
<ul>
<li><a href="#standards">Standards</a></li>
<li><a href="#tips">Tips</a></li>
</ul>
<a name="standards"></a>
<h2>Standards</h2>
<p>To keep our code consistent, we are implementing coding standards for YaBB 3. The current code does
not meet all of these and will be slowly fixed. Coding standards are important because
it makes the code more readable for other developers and for mod writers.</p>
<p>In addition to the standards listed below, we recommend reading Damian Conway's excellent
<a href="http://oreilly.com/catalog/9780596001735/">Perl Best Practices</a>. While we don't follow all of
the standards listed in the book, it still contains many excellent recommendations and ideas.</p>
<p>These standards are designed to be guides to how YaBB developers should write code. While these standards
may be broken in special cases, you should be prepared to explain why you have broken them.</p>
<p>We encourage mod writers to follow these standards as well.</p>
<ul>
<li><a href="standards/general.html">General Rules</a> -- General information that applies to all code.</li>
<li><a href="standards/pod.html">POD</a> -- Information on how we will use POD for our code's documentation</li>
<li><a href="standards/naming.html">Variables</a> -- Information on variable names and characteristics</li>
<li><a href="standards/regex.html">Regular Expressions</a> -- How we will keep our regexes from getting too unreadable.</li>
<li><a href="standards/subs.html">Subroutines</a> -- Some basic rules on writing subroutines.</li>
</ul>
<a name="tips"></a>
<h2>Tips</h2>
<p>We will be putting links to interesting articles about various Perl things in this section.</p>
</div>
<div id="footer">
<ul>
<li><a href="index.html">Home</a></li>
<li class="curpage"><a href="standards.html">Coding Standards</a></li>
<li><a href="roadmap.html">Project Roadmap</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="source.html">Browse SVN</a></li>
<li><a href="https://sourceforge.net/tm/?group_id=9008">Task Tracker</a></li>
<li><a href="http://www.yabbforum.com/team.php">Team</a></li>
</ul>
</div>
<div id="copy">Copyright &copy; 2009 Yet another Bulliten Board. All rights reserved.</div>
<div class="clearfix"></div>
</body>
</html>