Detail System Design - DED



Appendix C – Software Development Standards

Flex

Coding Conventions

[pic]

Action Script Standards

[pic]

MXML Scripting Standards

[pic]

Crystal Standards

File Organization

Crystal Source Files

Each Crystal-based report (*.rpt) will contain the source code. The Crystal-based reports implementation will be a collection of rpt files. The specific standard for source code snippets is the default Crystal Developer standards. Code snippets include code for formulas, parameters, SQL expression fields, and running total fields.

Naming Conventions

Naming conventions make programs more understandable by making them easier to read.

|Identifier Type |Rules for Naming |Examples |

|Table Name |Based on CCMS table naming standards. |CUST_LEGACY_DATA |

|Column Name |Based on CCMS column naming standards. |rin_num |

|Variable Name |All lowercase . |Age |

|Formula Field |First letter of each word is CAPS. Space between words is allowed. |Region Long Name |

|Functions |First letter of each word is CAPS. Space between words is not allowed. |CalcTotal |

INDENTATION

Crystal code snippets do not require indentation.

Line wrapping for if statements should generally use the 8-space rule, since conventional (4 space) indentation makes seeing the body difficult. For example:

//DON'T USE THIS INDENTATION

if ((condition1 && condition2)

|| (condition3 && condition4)

||!(condition5 && condition6)) { //BAD WRAPS

doSomethingAboutIt(); //MAKE THIS LINE EASY TO MISS

}

//USE THIS INDENTATION INSTEAD

if ((condition1 && condition2)

|| (condition3 && condition4)

||!(condition5 && condition6)) {

doSomethingAboutIt();

}

//OR USE THIS

if ((condition1 && condition2) || (condition3 && condition4)

||!(condition5 && condition6)) {

doSomethingAboutIt();

}

COMMENTS

Crystal code snippets comments begin with “//”.

WHITE SPACE

BLANK LINES

Blank Lines Improves readability by setting off sections of code that are logically related. Use blank lines to improve readability.

BLANK SPACES

Crystal allows unlimited blank spaces. Use blank spaces to improve readability.

DB2 Standards

[pic][pic]

JAVA Coding Standards

[pic]

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download