![]() |
ObjectInspector.inspect |
| Software Inspection Report Document | ||
|
Preparation Sheet Reviewer: Mike Power Author: Wes Strickland Work Product: ObjectInspector.inspect(Object, boolean) Mental White Box Testing: The method has no if's, loops, or any other control structure. Looking over the code I see that it can't handle null. Setting inspectee to null is not apparent that the method would fail, it is documented that it can't handle null. Calling setEditable on view when view is null would also cause a failure. It is not documented in the pre condition that view should be none null, or that instantiateMVC must be called successfully for this method to be successful. Coding Standard Checking: The coding standard for inspect is completely up to par. "{" is on the line after the method signature lined up with the first column of the method signature. The method itself is indented the correct 4 spaces also the code is indented 4 spaces beyond that. Both agreeing with standard. I found no tabs used. There is not space between method calls and the parameters passed to that method, which again adheres to standard. The operator according to style is separated on either side with a space. All coding style is up to par. Maintainability Checking: All required fields are present; description, pre-conditions, post conditions, param description. I do not like the quality of the fields. I feel that the description of the method is short and leaves much needed information out. As described early I think this method needs a proper pre-condition to so effect of requiring view to be none null. There should be some form of post-condition in my mind, doesn't the call view.setEditable(boolean) change in some way the state of the Object Inspector? The description of the Object param could use a touch up. Although it will do in my mind for now. The description of the boolean however I find vague and doesn't really describe what it is really doing. Reviewer: Mike Power Reviewee: Wes Strickland ObjectInspector.Inspect() Software Inspection 1. Need to add pre-condition that View is not null. Will throw an exception if it is null. 2. Add to description to show that the method needs to set the contents of the view. 3. Missing post-conidtion. |
||
| Issue# | Description | Acceptance |
| 1 | Need to add pre-condition that View is not null. Will throw an exception if it is null. |
Accept |
| 2 | Add to description to show that the method needs to set the contents of the view. |
Accept |
| 3 | Missing post-conidtion. | Accept |
| Software Inspection Summary | |||||
| Technical Defects Reported | 0 | Documentation Defects Reported | 3 | Coding Standard Defects Reported | 0 |
| Total Number of Defects | 3 | Overall Summary Pass or Fail | Fail | ||