The javadocs throughout the code were there but weren't too specific. The single method added had a simple overall description that outlined what the code basically did, although it was not formatted correctly.
The overall structure of the class was done quite well. If I were to code something out like this I would hope to have it organized in this same manner. Its clear, concise, and easy to read. The logic of it all was simple and the strategies implemented were clearly done.
After scouring the code for any sort of violations I found a few that were not up to the standards outlined in The Elements of Java Style (many violations occurring in the example IBM code borrowed). Here is a table of my findings.
CODE/FORMATTING VIOLATIONS FOUND
CODE/FORMATTING VIOLATIONS FOUND
File | Lines | Violation | Comments |
MyRuler.java | 44, 53, 57, * | EJS-7 | no whitespace included in line between () and { |
MyRuler.java | 38, 79, 87, * | EJS-7 | no blank line between logical sections of code |
MyRuler.java | 1,2,3, * | EJS-8 | Tabs used, not converted to whitespace |
MyRuler.java | 109 | EJS-9 | 'np' is not a meaningful name |
MyRuler.java | 38, 43, 52, * | EJS-37 | comments repeat code, does not add useful information |
MyRuler.java | 105, 110, 120, * | EJS-76 | Expression statements used instead of block statements |
MyRuler.java | 20, 98 | ICS-SE-Java-6 | Does not start with a capital and end with period. Should be a more complete sentence. |
Overall, I found Mari-Lee's code to be very clean and easy to read. With a little bit of time editing, her code will be looking top-notch and up to standards.
No comments:
Post a Comment