Downloaded 20 times
Uploaded byRoger Xia
Code reviews
This document discusses the importance and benefits of code reviews. It notes that code reviews can increase quality, reduce defects, improve readability, share knowledge within a team, and help people get to know each other better. The document outlines different methodologies for conducting code reviews, such as team reviews, pair programming, walkthroughs, and peer reviews. It also provides tips for preparing code for review and things reviewers should check for, such as naming conventions, logic, refactoring, performance, and security. Overall, the document promotes code reviews as a way to improve code quality and collaboration.
More Related Content
![[DevDay2018] Let’s all get along. Clean Code please! - By: Christophe K. Ngo,...](https://cdn.slidesharecdn.com/ss_thumbnails/christophek-180419103038-thumbnail.jpg?width=640&height=640&fit=bounds)
![Support, Monitoring, Continuous Improvement & Scaling Agentic Automation [3/3]](https://cdn.slidesharecdn.com/ss_thumbnails/agenticcommunityseries-day3-cfd-251120170304-ddef8112-thumbnail.jpg?width=640&height=640&fit=bounds)
Code reviews
- 1. Every Programmer ShouldKnow Code Reviews Roger Xia July 2012
- 2.
- 3. Programming & Codereview • Programming is – Taking an algorithm – Choosing a language – Using that language to implement algorithm and solve problems • Code review is –?
- 4. Why? • Increase Quality & Reduce Defects • Improve readability • Share knowledge in team • Know your workmate better! • Two Wrongs Can Make a Right • NOT personal attack! • NOT architect reviews everything
- 5. methodology • Team review(Planned 1-2 hour/week, Clear roles) • Pair programming (Share knowledge, 1 task) • Walkthrough (Author leads, reviewers take notes, higher level) • Peer review (Asynchronous) • Gerrit • Reaction & Ask questions
- 7. Preparation • Code Conventions • Findbugs • Tested • Test case
- 8. Take care of •naming convention spelling mistakes • business logic • refactoring • performance • security (attack, thread safe)
- 9. Refactoring • Refactoring modifiessoftware to improve its readability, maintainability, and extensibility without changing what it actually does. • Martin Fowler uses “code smells” to identify when to refactor. • Boss: "Refactoring is an overhead activity - I'm paid to write new, revenue generating features."
- 10. Code smells • Bad names • Duplicate code • Long method • Large class • Long parameter list • Temporary field • Speculative Generality • Data Class • Don’t flood log
- 11.
- 12. Meaningful Names • Classnames – Should be nouns or noun phrases. – Examples: Car, Account, DataRetrievalService, AddressParser • Method names – Should be verb or verbPhrases – Examples: parseData, deletePage, save – Methods that return boolean values should sound like question. – Examples: isAuthenticated, hasNoErrors, isEmpty • Interface and Implementation – ICache LRUCache – IExport ExportService • Constants – MAX_VALUE – SEP_COMMA, SEP_SEMICOLON
- 13. The Art ofReadable code • The book! • I want to point out: – Use blank to separate logic block.
- 14. Comments for complex process,algorithm, reasons
- 15. Aiming for simplicity •Do one thing in a function (simple responsibility) • Have no side effects. • Prefer exceptions to return codes. • Format your code.
- 16. DRY -- Don’trepeat yourself • Duplicated code should be avoided. • Object Orientation, Abstract! • Design pattern!
- 17. OO Principles • Simpleresponsibility principle: Class should have one and only one reason to change. • Encapsulation: Modules should not know internal details of objects it manipulates. • Polymorphism -- Liskov’s substitution principle: A subclass can be used as an argument where a base class is expected. • Open-closed principle: Class should be open for extention, but closed for modification.
- 18.
- 19. Pay Attention toPerformance • JAVA: JVM usage – Don’t create object in loop – Use ArrayList, HashMap etc as opposed to Vector, Hashtable etc (synchronized) where possible. Even better is to use just arrays where possible. – Set initial capacity of a collection (e.g. ArrayList, HashMap) and StringBuffer/StringBuilder appropriately. – Concurrent Collection, Lock – Lazy load or multi-threading where applicable. – Cache (LRUCache, Distributed Cache)
- 20. Pay Attention toPerformance
- 21. Pay Attention toSecurity • Sandbox (security manager, access manager, Classloaders, policies) • Scope: Access modifier to help protect your classes, methods, fields. – public, protected, private, package – Exceptions: object serialization, reflection, • Immutable class – final – String – Insecure direct object reference of mutable object • Type safe – Casting • Thread safe • OOM (static), file description handler, release resources (File, DBConnection) • SQL injection • Single point of failure
- 22.
- 23. Have Fun andwin http://rosettacode.org/wiki/Rosetta_Code
Editor's Notes
- #10 Loose couple:FacadeSpringMessaging
- #11 Temporary fieldAn attribute of an object is only set in certain circumstances; but an object should need all of its attributes Speculative Generality“Oh I think we need the ability to do this kind of thing someday” Data ClassThese are classes that have fields, getting and setting methods for the fields, and nothing else; they are data holders, but objects should be about data AND behavior
- #12 http://www.slideshare.net/srikanthps/practices-for-becoming-a-better-programmer-presentation
- #15 Are we writing comments because our code is unclear?Will you keep the comments up-to-date whenever code is updated?
- #17 If there is a bug in the code or code requires changes, then, one has to change it at multiple places.
- #19 http://www.lifeyun.com/design-pattern-diagram.html
- #20 http://www.artima.com/insidejvm/ed2/jvm2.html
- #21 http://www.artima.com/insidejvm/ed2/jvm2.html
- #22 Mitigation of serialization:- Don’t extend java.io.serializable- ImplementreadObject and writeObject as final methods that throw IOException- If serialize you must: use transient or use java.io.Externalizeable plus Encryption