Code Review Cheat Sheet

W
Document Sample
scope of work template
							Code Review Cheat Sheet

                             General                            Configuration
Classes                                                             Config files are separated
   Definition                                                       PerServer/PerInstallation specific data is inside separate files
       Would an Interface class be usefull?
       Does the inheritance make sense?                         Code Layout
       Correct xDoc-Documentation (In- & Ouput explained)           correct intendation
       Naming Convention matched                                    no lines longer than 1024px window
                                                                    includes at beginning of file
Functions
   Definition                                                   Error handling
       Correct xDoc-Documentation                                   Heavy errors stop the execution
       (Functionality, In-& Ouput explained)                        Error levels used
       Naming Convention matched
   Logic                                                                                    HTML/XHTML
      Input values are validated                                Tag Usage
       return correct return values                                 correct table - usage
       Function call responses are catched                          no use if depreciated tags
       Function logic is a combines equal logic
       Static values are inside Config Files                    Validation
                                                                    W3C validated
Variables
       Validate Data Type                                                                      Extended
       Validate Data Range                                      For advanced quality check
External Interfaces                                                 Unit Tests
   Files, Web/SOAP/XML, Globals, User Input, Config Data, DB,       Frontend Tests
   etc.
   => Validate access return.


Comments
   Each code block is explained

						
Related docs