Lab: Skills - Using VSCode to Check Syntax and Style

1. Getting Started: This part of the lab will help you get started.

If you are completing this lab on a lab computer, and this is the first time (this semester) that you are using VSCode on a lab computer, follow the instructions for configuring VSCode for this course that are available on the course "Help" page. (Note that Java and VSCode have already been installed on the lab computers, it just hasn't been configured for this course.)

If you are using your own computer and you have not yet done so, install and configure all of the tools following the instructions in the course "Help".
Create a directory/folder for this lab (e.g., named lab01) under the src directory.
Copy the files you downloaded to the directory/folder that you just created.
Start VSCode.
Click on in the activity bar. (This will open the explorer view in the primary side bar.)
Expand CS159, src, and the directory/folder you created for this lab.
Open an editor containing TripRecord.java by double-clicking on the file with that name in the explorer view.
Modify the package statement so that it is consistent with the directory/folder you created for this lab (e.g., package lab01;) and save the file.

2. Review: This part of the lab will help you review some things that you should know about Java classes.

"What kind of thing" is line 3?
.

An in-line comment.
"What kind of thing" are lines 4 through 10?
.

A block comment. Specifically, a block comment that describes the class in "javadoc" format.
Where can you learn about "javadoc" comments?
.

Obviously, there are many places. But it's always good to start with the Department's Wiki since it tends to be targeted towards the needs of JMU students. In this case: https://wiki.cs.jmu.edu/student/java/javadoc
"What kind of thing" is line 13?
.

A declaration statement.
What character terminates statements in Java?
.

A semi-colon.
"What kind of thing" are lines 23-27?
.

A constructor.
"What kind of thing" are lines 34-36?
.

A method (specifically, an accessor or getter).
How many instance attributes are in the TripRecord class?
.

Three (one int named passengers, one double named duration, and one double named length).

3. Basic Editing:

What, if anything, is overlayed on the icon at the left side of the window?
.

Nothing.
What "words" appear at the start of line 3? (Note: This is a good way to include reminders in your source code.)
.

The "words" TODO.
Change "Madisn" to "Madison" in line 8.
Now, what, is overlayed on the icon at the left side of the window?
.

The number 1.
Click on File+Save (or type Ctrl+S).
Now, what is overlayed on the icon at the left side of the window?
.

Nothing.
What do you think the number tells you?
.

The number of files that have been changed/edited since they were last saved.
Click just to the right of the semi-colon in the declaration of the attribute named passengers.
What line and column is the cursor on? (Hint: Look at the status bar at the bottom of the window.)
.

The way my version is formatted, it's line 13, column 28 (which is denoted as 13:28).
The word private is a visibility/accessibility modifier in Java so, VSCode presents it in a special color.
What color?
.

On my machine, blue.
What color are attributes, method names, and parameters?
.

On my machine, dark blue.
Click on Help+Show All Commands, enter "Delete" in the textfield, and find the command that deletes an entire line.
Click anywhere on line 3 (i.e., the TODO comment), and press the keys needed to to delete the entire line.
Save the file.
Hover the mouse over the blank space between the line number and the start of the first block comment and click on the character that appears. What happens?
.

The comment is collapsed so that it takes up less space.
Click on the greater than sign next to the first line of the first block comment. What happens?
.

The comment is expanded again.
Change the indentation of several lines in the file (i.e., indent some lines more and some lines less). Now, right-click inside the document and pull down to Format Document. What happened?
.

All of the indentation was corrected.

4. Checking Syntax: VSCode compiles source code "on the fly", so it immediately detects syntax errors. This part of the lab will help you become comfortable with this feature.

Delete the semi-colon at the end of the statement that declares the attribute passengers. What happens?
.

An editor decoration appears in line that was just changed.
Hover your mouse over the editor decoration. What happens?
.

A message appears that says something like "Syntax error, insert ;".
What color is the editor decoration?
.

Red.
Find this error in the problems view. What caused it?
.

It is a syntax error in Java.
Fix the syntax error. What happens?
.

The editor decoration disappears.
Change the appropriate assignment statement so that 50.5 is assigned to this.passengers. What is the syntax error?
.

Something like "Type mismatch, Can't convert from double to int".
Change the assignment statement so that (int) 50.5 is assigned to this.passengers. Why isn't this a syntax error?
.

Because the double literal 50.5 is being typecast (not rounded)to the int value 50.
Change the assignment statement so that duration is assigned to this.passengers. What is the syntax error?
.

It's the same error (even though a variable is used instead of a literal) - "Type mismatch, Can't convert from double to int".
Change this line so that passengers is assigned to this.passengers (as it was originally).
Change the appropriate assignment statement so that 5 is assigned to this.length. Why isn't this a syntax error?
.

Because Java will widen the int literal 5 into a double.
Change the assignment back to what it was.
Change the return statement in the getPassengers() method so that it returns the value 10.9. What is the syntax error?
.

Something like "Type mismatch; cannot convert from double to int."
Why is this a syntax error?
.

Because the declaration of the getPassengers() method says it returns an int, but the return statement actually returns a double.
Change this line back to what it was originally.
Change passengers to passenger in the declaration statement. How many warnings/errors are there now (and what are they)?
.

Three - one on line 11 ("The value of the field is never used"), one on line 22 ("passengers cannot be resolved to a field"), and one on line 51 ("passengers cannot be resolved to a field").
In this case, given what you know about the original code, what is the cause of these three warnings/errors?
.

The misspelling in the declaration statement.
"Fix" the error (incorrectly) in the declaration statement by deleting it. What happens?
.

There are now only two warnings/errors.
What does this tell you about fixing syntax errors?
.

It's important to find the root cause of the error, which may not be where the warning/error occurs.
Fix the error correctly. That is, edit the code so that there is again a declaration statement of a private instance attribute of type int named passengers

5. Logic Defects Caught by VSCode: IDEs can't detect most logic defects, but they can help with some.

Change the assignment statement in the constructor to length = length;. What is the warning/error?
.

Something like "The assignment to variable has no effect"
What is this warning/error telling you?
.

That you have assigned the parameter named length to itself, which achieves nothing (because it is tantamount to taking something out of a box and then putting it back in the box).
What color is the is the editor decoration?
.

Orange.
Find this warning/error in the problems view. What caused it?
.

It is a violation of the course style guide that was identified by Checkstyle.
Fix the defect.
What is the purpose of the reference this in the assignment statements in the constructor?
.

It distinguishes the instance attribute named length from the parameter named length.
What is the . in the assignment statements in the constructor?
.

It is the membership operator. In says, for example, that this.length is an instance attribute of the owning object.

6. Logic Defects Not Caught by VSCode: Unfortunately, VSCode can't detect even some obvious logic defects. This part of the lab helps you understand some of them.

Change the declaration statement so that 0 is assigned to the instance attribute named length. What change did you make?
.

this.length = 0;
Is this a logic defect?
.

Yes, because the purpose of a constructor is to correctly initialize the instance attributes, and this statement does not do that.
What warning/error appears?
.

None appear - this is not a logic defect that VSCode can detect. You have to find these defects on your own!
Change the declaration statement so the parameter named duration is assigned to the instance attribute named length. What change did you make?
.

this.length = duration;
Is this a logic defect?
.

Yes, because the wrong value is being assigned to the instance attribute named length.
What warning/error appears?
.

None appear - again this is not a logic defect that VSCode can detect. You have to find these defects on your own!
Change the declaration statement so that it correctly initializes the instance attribute named length. What change did you make?
.

this.length = length;

7. Checking Style: If you installed everything properly, you can have VSCode (using a program called Checkstyle) check to make sure that your code conforms to the course style guide. This part of the lab will help you use Checkstyle.

Delete the leading spaces (or tab) in the line that contains the declaration of the constructor (so that the statement starts in column 1) and save the file. Is this a syntax error?
.

No, the Java syntax does not require a particular indentation scheme (as does, for example, Python).
Is this a style defect?
.

Yes - the course styleguide (which you should read if you haven't already) requires that statements in methods be indented.
Does VSCode indicate that there is a style defect?
.

Yes, an editor decoration appears on the line.
What color is the is the editor decoration?
.

Orange.
Find this warning/error in the problems view. What caused it?
.

It is a violation of the course style guide that was identified by Checkstyle.
Hover the mouse over the editor decoration. What message appears?
.

Something like "Child has incorrect indentation level".
Fix the style defect. What happens?
.

The editor decoration on that line goes away.
Delete the period at the end of first line in the block comment for the constructor. What happens?
.

An editor decoration appears that says something like "First sentence should end with a period".
Fix the defect.
Change the first occurrence of the word passengers in the block comment for the constructor to passenger and save the file. Is this a style defect?
.

Yes, because all formal parameters must have a Javadoc comment that describes them, and the formal parameter named passengers no longer does.
What editor decorations appear?
.

Two different editor decorations are displayed.
Given what you know about the code, which is correct?
.

The second one.
Fix the style defect (i.e., spell passengers correctly). What happens?
.

Both editor decorations disappear.
What does this tell you about correcting style defects?
.

Even though Checkstyle is very helpful, thought is required.
Change the spelling of the getDuration() method to GetDuration(). Is this a style defect?
.

Yes, the styleguide requires that method names start with a lower-case letter.
Did Checkstyle detect the defect?
.

Yes.
Fix the defect.

8. Style Issues Not Caught by Checkstyle: Unfortunately, Checkstyle does not check for everything in the styleguide. This part of the lab will help you understand that you are ultimately responsible for conforming to the style guide.

Change the order of the getLength() and getDuration() methods without changing the methods themselves and save the file. Is this a style defect?
.

Yes, the styleguide requires that methods be in alphabetical order.
Does Checkstyle detect this defect?
.

No.
Fix the defect.
Fix any remaining style defects.

9. Comparing Files: "diff" utilities are a convenient way to compare two (or more) versions of the same file. "Visual diff" utilities do so by showing the two files side-by-side in a window with visual cues that help you easily see the differences. This part of the lab will help you compare two versions of the same Java source file to see what changes you made.

In the explorer view, right-click on TripRecord.java and pull down to Open Timeline. What happens?
.

A time line view appears under the expolorer view.
Select a previouse version of TripRecord.java. What happens?
.

A window appears with the two versions of TripRecord.java side-by-side.
Drag the scrollbar up and down. What happens?
.

The two files scroll simultaneously.
How does the "visual diff" tool indicate differences between the two versions?
.

It highlights them in various different colors.
Close the "Visual diff" window.