MadJavaEntSpring2017 / assist

0 stars 0 forks source link

Week 8 review by O Collins #4

Open ocollins opened 7 years ago

ocollins commented 7 years ago

Design/Code Review 2

Project:

Developer:

Reviewer:

Category Criteria Analysis/Comments
Running application
Describe the application functionality that has been built and is working. The home page,league info page, manager's page, login
What is good? Spring framework is implemented. Classes are well structured and organized. Nice use of a Base test class, performing common tasks
What could be improved? Not sure at this point. Good start for the project.
Unit Tests
What are the code coverage statistics?
Are @Before/@BeforeClass/@After/@AfterClass used to reduce redundant code? There is Spring version of @Before. Not sure about @After
JSPs
Is templating used to eliminate rendundant code(for example, header.jsp, footer.jsp, etc.) Yes, so far there is a head.jsp module that is reused in several jsps.
What is good? Good start to the project
What could be improved? There is some css code in jsps, which could be moved into a separate .css file
Code quality
Are methods single-purpose? Yes, logic is broken down into small methods.
Are classes appropriately-sized classes (no monster classes)? No monster classes
Are the same lines of code repeated at all? No repeating of code at this point
Do any classes perform very similar functions that could be candidates for super/subclass relationships? Each class is coded to perform distinct functionality
Are any values hard-coded that should be in a properties file? Not at this point
Are variable names descriptive? Variable names are clear what they are used for
Are there many branches or loops that could be simplified or broken up into smaller methods? Not at this point
Do the DAOs use Hibernate? No hard-coded sql! DAOs use Hibernate
Has log4J been added? log4J is used effectively in tests
Are there logging statements in the code? Yes
Are appropriate logging levels used? Info, debug, error, for example. Yes
Are there any System.out.printlns in the code? Did not see any
Other comments/notes?
Web Service/API integration Which web service/api is being used?
Is the integration built?
If so, evaluate the integration code. What is good? What could use improvement?
Independent research topic What is the developer's independent research topic?
Has the topic been implemented in the project?
If so, evaluate the implementation. What is good? What could use improvement?
Key takeaways List at least 3 things you learned while reviewing this project that will help you in your own project. Possibly Lombok
pawaitemadisoncollege commented 7 years ago

Looks like some missing info here? Web api/service? Independent research topic?