Herreray code review #4
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Source: https://martinfowler.com/bliki/TechnicalDebt.html When reviewing the code – in what has been tested the foodDescription and foodImage tags were not utilized in the project testing, so I removed them in an attempt to reduce current clutter.
Source: https://martinfowler.com/bliki/TechnicalDebt.html In a method it is bad practice to declare unused variables.
Source: https://rhamedy.medium.com/a-short-summary-of-java-coding-best-practices-31283d0167d3 Using their recommendation of well indented exception messages that can better diagnose what went wrong.
discospiff
reviewed
Nov 21, 2021
| } | ||
| return food; |
There was a problem hiding this comment.
Careful here. food is initialized to null, so what happens if an exception is thrown?
The exception is logged, and discarded, and then a null is returned.
That puts you in a worse off position, because you'll end up with an ambiguous NullPointerException later.
This is a case where it might be better to just allow the exception to be thrown, so that the calling method knows what happened.
discospiff
reviewed
Nov 21, 2021
Comment on lines
-9
to
+12
| private int foodId; | ||
| private String foodId; | ||
| private String foodName; | ||
| private String foodCategory; | ||
| private String foodDescription; | ||
| private double foodPrice; | ||
| //Might need to create another class for this based off of what the professor has done in his project | ||
| //private MultipartFile foodImage; | ||
| private String foodCategory; | ||
| private double foodPrice; |
There was a problem hiding this comment.
What is the technical debt reduction here?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Analysis of the program.
The program seems to be very similar to the individual assignment that we were working on, and is tailored to the project goal that they have set out for.
Was the program available in UC Github on time?
The project was pushed to their GitHub at the link they have provided, but I was not given access as a collaborator on time which is the reason for this later pull request.
Is the program easy for you, as an outsider, to understand?
It was easy for me to understand the intention of the project, which seems to be an application designed around ordering food from a restaurant’s menu.
Does the program compile?
Yes, the program compiled and completed the 3 tests designed by the team.
Three technical concepts learned:
Sources used:
https://www.capitalone.com/tech/software-engineering/10-microservices-best-practices/
https://martinfowler.com/bliki/TechnicalDebt.html
https://rhamedy.medium.com/a-short-summary-of-java-coding-best-practices-31283d0167d3