| <?xml version="1.0" encoding="UTF-8"?> |
| <org.eclipse.epf.uma:ContentDescription xmi:version="2.0" |
| xmlns:xmi="http://www.omg.org/XMI" xmlns:org.eclipse.epf.uma="http://www.eclipse.org/epf/uma/1.0.4/uma.ecore" |
| xmlns:epf="http://www.eclipse.org/epf" epf:version="1.2.0" xmi:id="--qg2qc3dqmgeB63Nx7Zndg" |
| name="coding_standard,8.8116853923311E-307" guid="--qg2qc3dqmgeB63Nx7Zndg" changeDate="2006-11-09T19:13:06.585-0500" |
| version="1.0.0"> |
| <mainDescription><a id="XE_xp__coding_standard" name="XE_xp__coding_standard"></a><a id="XE_coding_standard__practice_of" name="XE_coding_standard__practice_of"></a><a id="XE_engineering_practices__coding_standard" name="XE_engineering_practices__coding_standard"></a> 
 |
| <h3>
 |
| Description
 |
| </h3>
 |
| <p>
 |
| Using a coding standard is a software development practice that has been widely accepted in the industry. The need for
 |
| this practice takes on added importance in XP because of the increased level of communication required by collective
 |
| ownership, pair programming and the constant refactoring of the code. The team should have a standard way of naming and
 |
| formatting things so they can understand the code quickly and know where to look at all times.
 |
| </p>
 |
| <p>
 |
| Ideally, the coding standard should be the result of team consensus. In some cases, decisions will be arbitrary
 |
| (placement of braces). Each item in the standard should support one or more goals, improved communication being one of
 |
| the most critical goals. Once the team agrees on a standard, all members of the teams are expected to follow it. Pair
 |
| programming and collective code ownership is sufficient to reinforce the use of the standard within the team. With
 |
| time, the team will use and modify the standard to develop a style that is well adapted to their environment.
 |
| </p>
 |
| <h3>
 |
| Benefits
 |
| </h3>
 |
| <ul>
 |
| <li>
 |
| <b>Improved communication</b>: increases the ability to read each other's code.
 |
| </li>
 |
| <li>
 |
| <b>Refactoring support</b>: provides consistently shaped code.
 |
| </li>
 |
| </ul></mainDescription> |
| </org.eclipse.epf.uma:ContentDescription> |
