Detail System Design - DED
Total Page:16
File Type:pdf, Size:1020Kb
Detail System Design - DED
APPENDIX C – SOFTWARE DEVELOPMENT STANDARDS
FLEX
Coding Conventions
TANF Flex Coding Conventions.docx
Action Script Standards
Action Script Standards.pdf
MXML Scripting Standards
MXML Standards.pdf
Appendix C – Software Development Page C-1 Child Care Management System Standards CCMS-Del-Des-DSD- 1 0 Appendix C.Doc Detail System Design - DED
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 Rules for Naming Examples Type Table Name Based on CCMS table naming standards. CUST_LEGACY_DATA Column Based on CCMS column naming standards. rin_num Name Variable All lowercase . Age Name Formula Field First letter of each word is CAPS. Space between Region Long Name words is allowed. Functions First letter of each word is CAPS. Space between CalcTotal words is not allowed.
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();
Appendix C – Software Development Page C-2 Child Care Management System Standards CCMS-Del-Des-DSD- 1 0 Appendix C.Doc Detail System Design - DED
} //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
I150-135 IL DB2 SQL Standards and Standards.pdf DB Stds and Procs.doc
JAVA CODING STANDARDS
WVS Java Coding Standards.docx
Appendix C – Software Development Page C-3 Child Care Management System Standards CCMS-Del-Des-DSD- 1 0 Appendix C.Doc