1 / 9

11.1 Code Review

11.1 Code Review. ATS Application Programming: Java Programming. 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. Review Code.

snyderlinda
Download Presentation

11.1 Code Review

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. 11.1 Code Review ATS Application Programming: Java Programming

  2. 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

  3. Review Code • 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.

  4. Code Review Documents • Code Review Checklist • Java Coding Guidelines – Code Conventions.pdf • Enforcement of Coding Standards in Eclipse - JDS document

  5. 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

  6. 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

  7. 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

  8. Key Resource Links Accenture Methods: https://manilamethods.accenture.com/cd&am/content/codereviewchecklist.asp Others: http://www.chimu.com/publications/javaStandards/part0003.html http://www.tenet.res.in/documents/CodeReviewGuidelines.pdf

  9. Questions and Comments ???

More Related