11 1 Code Review ATS Application Programming Java

Objectives • Describe general concepts and guidelines in conducting code reviews • Describe documents

Review Code Responsible: Reviewer Review the component / code to: • Verify the data

Code Review Documents • Code Review Checklist • Java Coding Guidelines – Code Conventions.

Code Review Checklist General • Code modules can be traced back to the corresponding

Code Review Checklist Comments • Commenting standards have been followed • The code is

Code Review Checklist Code • All classes, operations, parameters, etc. , use descriptive names

Key Resource Links Accenture Methods: https: //manilamethods. accenture. com/cd&am/content/coder eviewchecklist. asp Others: http: //www.

Questions and Comments © Accenture 2005 All Rights Reserved 9

Slides: 9

Download presentation

Objectives • Describe general concepts and guidelines in conducting code reviews • Describe documents and deliverables involved in code reviews • Outline roles and responsibilities in conducting code reviews © Accenture 2005 All Rights Reserved 2

Review Code Responsible: Reviewer Review the component / code to: • Verify the data definition language (DDL) used with the production database against the database design/physical data model, where applicable • Verify that project standards are met • Examine and validate the code, raising such issues as mismatched interfaces, algorithm implementation or potential performance problems • Check the comments for clarity Refer to the 7576 Perform Peer Review Task for more details. © Accenture 2005 All Rights Reserved 3

Code Review Checklist General • Code modules can be traced back to the corresponding designs, use cases, and requirement items • There is adherence to coding standards and templates • Good coding style has been applied. It is easy to understand the code without the use of other supporting documentation • All known syntactic and semantic errors within the code have been fixed © Accenture 2005 All Rights Reserved 5

Code Review Checklist Comments • Commenting standards have been followed • The code is clear and easy to read • The comments have been up-to-date and consistent with the code • The comments focus on “why, ” not “how” • All exceptions, workarounds, limitations, known defects, etc. , are commented upon © Accenture 2005 All Rights Reserved 6

Code Review Checklist Code • All classes, operations, parameters, etc. , use descriptive names • The code is consistent with the detailed designs • Correct error handling code is present • Normal flows are clearly distinguishable from other exceptional paths • The body of each operation is not too big • The body of each operation is not too complex • Proper naming, definition/declaration, scoping, initialization, and usage of all variables (global and local) have been applied in the code • The presence, format, and type of all required inputs and production of all required outputs • Proper memory allocation and de-allocation have been applied © Accenture 2005 All Rights Reserved 7

Key Resource Links Accenture Methods: https: //manilamethods. accenture. com/cd&am/content/coder eviewchecklist. asp Others: http: //www. chimu. com/publications/java. Standards/part 0003. html http: //www. tenet. res. in/documents/Code. Review. Guidelines. pdf © Accenture 2005 All Rights Reserved 8