|
ETAMainView() |
| Software Inspection Report Document | ||
|
Preparation sheet for software inspection of ETAMainView.() Reviewed by: Jonathon Lee 1) Mental White Box Testing: Nothing is passed into the constructor and there are no control statements…..so no boundary conditions exist. 2) Coding Standard Checking: JTextArea ta = new JTextArea(); doesn't have a comment OutputStream outStr and PrintStream printStr also don't have comments Variable ta might not convey enough information…..needs to be longer 3) Maintainability Checking: Some of the pseudocode for setting the menu up don't correspond to the statements Frivolous comment about initializing text areas needs to be removed Pseudocode says 'INITIALIZE messageCBDL…', yet there is no code for that The pseudocode for adding a test menu says 'fileMenu' instead of 'testMenu' The GUI setup code for adding the tabs and panels is very obscure and doesn't have any comments These are the notes and summary of Jon's inspection of Mike Hebron's ETAMainview.ETAMainView() code. notes: -JTextArea ta declared and not commented -OutputStream outStr and PrintStream printStr do not have comments when they are declared. -pseudocode order doesn't match code order in some places -remove the unecessary comment about initializing text areas -change pseudocode when talking about the test menu - it still says file menu on for some things when it should say test menu -add additional comments to GUI code to make it more readable; that is, don't use gridbag constraints constructors everywhere, but set the fields manually to help with the readability Summary: there are changes that need to be made, as described above |
||
| Issue# | Description | Acceptance |
| 1 | JTextArea ta declared and not commented | Accept |
| 2 | OutputStream outStr and PrintStream printStr do not have comments when they are declared. | Accept |
| 3 | pseudocode order doesn't match code order in some places | Accept |
| 4 | remove the unecessary comment about initializing text areas | Accept |
| 5 | change pseudocode when talking about the test menu - it still says file menu on for some things when it should say test menu | Accept |
| 6 | add additional comments to GUI code to make it more readable; that is, don't use gridbag constraints constructors everywhere, but set the fields manually to help with the readability | Vetoed by QA |
| Software Inspection Summary | |||||
| Technical Defects Reported | 0 | Documentation Defects Reported | 3 | Coding Standard Defects Reported | 2 |
| Total Number of Defects | 5 | Overall Summary Pass or Fail | Fail | ||