| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C/DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"> |
| <!-- VERSION rmc:7.1.0 --> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| <!-- START NON-TRANSLATABLE --> |
| <title>\xp\tasks\define_coding_standard.xmi</title> |
| </head> |
| <!-- WARNING: do not modify the generated comments in this file below this line. They are used as markers for the import process. --> |
| <body> |
| Element Name: define_coding_standard.xmi<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: presentationName<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:presentationName,{C88D5B0A-1A59-4575-ADDF-8ECBBAB83410} CRC: 3842185346 -->Define Coding Standard<!-- END:presentationName,{C88D5B0A-1A59-4575-ADDF-8ECBBAB83410} --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: purpose<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:purpose,-qIbMRqe8wqKN2-HLtNUcLw CRC: 2421563188 --><a id="XE_define_coding_standard__activity_definition" name="XE_define_coding_standard__activity_definition"></a> |
| <ul> |
| <li> |
| To aid clarity by making the style of code as familiar as possible. |
| </li> |
| </ul><!-- END:purpose,-qIbMRqe8wqKN2-HLtNUcLw --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: name<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:name,_oCfyEGE-EdqnIZeW8YpHcA CRC: 3504642577 --> Write Prototypical Classes <!-- END:name,_oCfyEGE-EdqnIZeW8YpHcA --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: sectionDescription<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:sectionDescription,_oCfyEGE-EdqnIZeW8YpHcA CRC: 2200218799 --><a id="Step1" name="Step1"></a> |
| <p> |
| When deciding on a coding standard, take the time to write a few classes which use a particular style. Should the curly |
| braces be flush with the indentation of the line above? Do we use tabs or spaces? Are abbreviations permitted? If so, |
| do we have a short list? |
| </p><!-- END:sectionDescription,_oCfyEGE-EdqnIZeW8YpHcA --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: name<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:name,_oCfyEWE-EdqnIZeW8YpHcA CRC: 897499029 --> Discuss Standard <!-- END:name,_oCfyEWE-EdqnIZeW8YpHcA --> |
| <br/><br/><br/> |
| <!-- START NON-TRANSLATABLE --> |
| Attribute: sectionDescription<br/><br/> |
| <!-- END NON-TRANSLATABLE --> |
| <!-- START:sectionDescription,_oCfyEWE-EdqnIZeW8YpHcA CRC: 644219774 --><a id="Step2" name="Step2"></a> |
| <p> |
| The coding standard for a project should be as simple as possible. The goal is not to forbid error prone constructs, |
| but rather to make the code as communicative and uniform as possible so it can be understood and worked on readily. If |
| the team cannot reach consensus, use majority rule. Having a standard is more important than the specific details. |
| </p> |
| <p> |
| <br /> |
| |
| </p><!-- END:sectionDescription,_oCfyEWE-EdqnIZeW8YpHcA --> |
| </body> |
| </html> |
