blob: 346973c6688f0b78af5b6ad81ed166bedb921181 (
plain)
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<title>Overview - Zend Framework Manual</title>
</head>
<body>
<table width="100%">
<tr valign="top">
<td width="85%">
<table width="100%">
<tr>
<td width="25%" style="text-align: left;">
<a href="coding-standard.html">Zend Framework Coding Standard for PHP</a>
</td>
<td width="50%" style="text-align: center;">
<div class="up"><span class="up"><a href="coding-standard.html">Zend Framework Coding Standard for PHP</a></span><br />
<span class="home"><a href="manual.html">Programmer's Reference Guide</a></span></div>
</td>
<td width="25%" style="text-align: right;">
<div class="next" style="text-align: right; float: right;"><a href="coding-standard.php-file-formatting.html">PHP File Formatting</a></div>
</td>
</tr>
</table>
<hr />
<div id="coding-standard.overview" class="section"><div class="info"><h1 class="title">Overview</h1></div>
<div class="section" id="coding-standard.overview.scope" name="coding-standard.overview.scope"><div class="info"><h1 class="title">Scope</h1></div>
<p class="para">
This document provides guidelines for code formatting and documentation to
individuals and teams contributing to Zend Framework. Many developers using Zend
Framework have also found these coding standards useful because their code's style
remains consistent with all Zend Framework code. It is also worth noting that it
requires significant effort to fully specify coding standards.
</p>
<blockquote><p><b class="note">Note</b>:
Sometimes developers consider the establishment of a standard more important
than what that standard actually suggests at the most detailed level of
design. The guidelines in Zend Framework's coding standards capture practices
that have worked well on the Zend Framework project. You may modify these
standards or use them as is in accordance with the terms of our <a href="http://framework.zend.com/license" class="link external">» license</a>.
<br />
</p></blockquote>
<p class="para">
Topics covered in Zend Framework's coding standards include:
</p>
<ul class="itemizedlist">
<li class="listitem">
<p class="para"><acronym class="acronym">PHP</acronym> File Formatting</p>
</li>
<li class="listitem">
<p class="para">Naming Conventions</p>
</li>
<li class="listitem">
<p class="para">Coding Style</p>
</li>
<li class="listitem">
<p class="para">Inline Documentation</p>
</li>
</ul>
</div>
<div class="section" id="coding-standard.overview.goals" name="coding-standard.overview.goals"><div class="info"><h1 class="title">Goals</h1></div>
<p class="para">
Coding standards are important in any development project, but they are particularly
important when many developers are working on the same project. Coding standards
help ensure that the code is high quality, has fewer bugs, and can be easily
maintained.
</p>
</div>
</div>
<hr />
<table width="100%">
<tr>
<td width="25%" style="text-align: left;">
<a href="coding-standard.html">Zend Framework Coding Standard for PHP</a>
</td>
<td width="50%" style="text-align: center;">
<div class="up"><span class="up"><a href="coding-standard.html">Zend Framework Coding Standard for PHP</a></span><br />
<span class="home"><a href="manual.html">Programmer's Reference Guide</a></span></div>
</td>
<td width="25%" style="text-align: right;">
<div class="next" style="text-align: right; float: right;"><a href="coding-standard.php-file-formatting.html">PHP File Formatting</a></div>
</td>
</tr>
</table>
</td>
<td style="font-size: smaller;" width="15%"> <style type="text/css">
#leftbar {
float: left;
width: 186px;
padding: 5px;
font-size: smaller;
}
ul.toc {
margin: 0px 5px 5px 5px;
padding: 0px;
}
ul.toc li {
font-size: 85%;
margin: 1px 0 1px 1px;
padding: 1px 0 1px 11px;
list-style-type: none;
background-repeat: no-repeat;
background-position: center left;
}
ul.toc li.header {
font-size: 115%;
padding: 5px 0px 5px 11px;
border-bottom: 1px solid #cccccc;
margin-bottom: 5px;
}
ul.toc li.active {
font-weight: bold;
}
ul.toc li a {
text-decoration: none;
}
ul.toc li a:hover {
text-decoration: underline;
}
</style>
<ul class="toc">
<li class="header home"><a href="manual.html">Programmer's Reference Guide</a></li>
<li class="header up"><a href="manual.html">Programmer's Reference Guide</a></li>
<li class="header up"><a href="coding-standard.html">Zend Framework Coding Standard for PHP</a></li>
<li class="active"><a href="coding-standard.overview.html">Overview</a></li>
<li><a href="coding-standard.php-file-formatting.html">PHP File Formatting</a></li>
<li><a href="coding-standard.naming-conventions.html">Naming Conventions</a></li>
<li><a href="coding-standard.coding-style.html">Coding Style</a></li>
</ul>
</td>
</tr>
</table>
</body>
</html>
|
