... | ... | @@ -77,58 +77,16 @@ Inspector: Kun Niu |
|
|
[Zhihui_Huang_report.txt](uploads/77745a17e80766eea44c8c97290d0cd8/Zhihui_Huang_report.txt)
|
|
|
|
|
|
|
|
|
Findings Report
|
|
|
**Report For Yiru Xiao**
|
|
|
Inspector: Pranav Chaudhari
|
|
|
[Software_Quality_Inspection_Checklist_for_Java_Classes.docx](uploads/9962f972f2b4811df39eb4b777ce391f/Software_Quality_Inspection_Checklist_for_Java_Classes.docx)
|
|
|
|
|
|
Inspector’s Name: Pranav Chaudhari
|
|
|
|
|
|
Inspecting: Yiru Xiao’s work
|
|
|
|
|
|
Date Started: March 10, 2020
|
|
|
|
|
|
Date Completed: March 13, 2020
|
|
|
|
|
|
Project Name: Transfast
|
|
|
|
|
|
Time Report:
|
|
|
|
|
|
Time spent on Familiarization with the Code: 2-3 hours
|
|
|
|
|
|
Time spent on Filling in Findings Report: 2 hours
|
|
|
|
|
|
Time spent on Actual Inspection: 2 hours
|
|
|
|
|
|
Findings:
|
|
|
|
|
|
I have inspected the homepage and category page. Both those pages are very simply made with comments to navigate what part is where. Which is why familiarizing with her code made it very easy. Very simple to understand what each part of the code does, that made it very time effective. The code is organised and very well indented.
|
|
|
|
|
|
# Description Line # Class Name Associated Checklist Item #
|
|
|
|
|
|
1 Homepage 24-67 Navigation 1,2,4,5,6,7,8
|
|
|
|
|
|
2 Homepage 79-379 Page Features 1,2,4,5,6,7,8
|
|
|
|
|
|
3 Categories 26-69 Navigation 1,2,4,5,6,7,8
|
|
|
|
|
|
4 Categories 72-271 Page Content 1,2,4,5,6,7,8
|
|
|
|
|
|
|
|
|
Further Comments from the Inspection of this Class:
|
|
|
|
|
|
|
|
|
1. Completeness:
|
|
|
• The code provided for each page works very well and each function works. Each method has appropriate naming and appropriate usage of it.
|
|
|
2. Consistency:
|
|
|
• The code is very consistent which made it very easy to understand, names are the same, indentation is done very well, each div is intended as well as each container this makes the code very clean and appealing to look at, Names are consistent in HTML files as well as CSS files.
|
|
|
3. Efficient Processing:
|
|
|
• The code is not complex and very easy to understand since it’s commented and indented which makes it efficient and clean.
|
|
|
4. Efficient Storage:
|
|
|
• All variable and all the classes are used and they are organised in a way from top to bottom and left to right and how the page is laid out, which is useful in understanding the code and page layout.
|
|
|
5. Simplicity:
|
|
|
• It is very simple to understand the code. Nothing that is implement long other then it being repeated few times as it is implementing same things. Most methods are few lines and simple with comments to make a person who doesn’t know coding.
|
|
|
6. Self-Description:
|
|
|
• Comments are provided for purpose of telling us what part of the page is coded. Comments are provided for each part of the page. All the names of each part are chosen wisely and each to understand, which reflect their usage and purpose.
|
|
|
7. Reusability:
|
|
|
• The code is very well implemented, and it can definitely be reusable, and it has been, code of navigation from homepage is re-used in all of our pages such as categories. It could be used to develop any webpage for front-end, and code is implemented in a way that it would be easy to change and edit it.
|
|
|
|
|
|
|
|
|
|