blob: d5f0a6bf99a050c2819a067252f1cc9272035b61 [file] [log] [blame]
<?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.3/uma.ecore" epf:version="1.0.0" xmi:id="--qg2qc3dqmgeB63Nx7Zndg" name="coding_standard,8.8116853923311E-307" guid="--qg2qc3dqmgeB63Nx7Zndg" changeDate="2006-11-09T16:13:06.585-0800" version="1.0.0">
<mainDescription>&lt;a id=&quot;XE_xp__coding_standard&quot; name=&quot;XE_xp__coding_standard&quot;&gt;&lt;/a&gt;&lt;a id=&quot;XE_coding_standard__practice_of&quot;
name=&quot;XE_coding_standard__practice_of&quot;&gt;&lt;/a&gt;&lt;a id=&quot;XE_engineering_practices__coding_standard&quot;
name=&quot;XE_engineering_practices__coding_standard&quot;&gt;&lt;/a&gt;
&lt;h3&gt;
Description
&lt;/h3&gt;
&lt;p&gt;
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.
&lt;/p&gt;
&lt;p&gt;
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.
&lt;/p&gt;
&lt;h3&gt;
Benefits
&lt;/h3&gt;
&lt;ul&gt;
&lt;li&gt;
&lt;b&gt;Improved communication&lt;/b&gt;: increases the ability to read each other's code.
&lt;/li&gt;
&lt;li&gt;
&lt;b&gt;Refactoring support&lt;/b&gt;: provides consistently shaped code.
&lt;/li&gt;
&lt;/ul&gt;</mainDescription>
</org.eclipse.epf.uma:ContentDescription>