CSIS 110 Lecture 25: Quiz Results and Javadoc Comments - Prof. Brian F. Hanks, Study notes of Javascript programming

An overview of the results of a quiz in a csis 110 class, as well as information on how to use javadoc comments to generate documentation for java code. Statistics on quiz performance, feedback from students, and instructions on how to write effective javadoc comments.

Typology: Study notes

Pre 2010

Uploaded on 08/05/2009

koofers-user-8vo-1
koofers-user-8vo-1 ๐Ÿ‡บ๐Ÿ‡ธ

10 documents

1 / 6

Toggle sidebar

This page cannot be seen from the preview

Don't miss anything!

bg1
CSIS 110 - Lecture 25
Class 22: quiz review, class 23: quiz, class 24: out of town
Announcements:
Next programming assignment is on the course web site. We'll begin covering the
material you need for it today.
Reading: 5.10 to 5.12
Evaluation Summary:
7 participants (10 students in class)
Median: 4 or more on all questions
Question 10: overall effectiveness as a teacher: mean = 4, median = 4
Question 16: course as a learning experience: mean 4.33, median 4
Mean: 4 or greater on all questions except for two.
Question 2: clarity and understandability. Mean 3.86, median 4. ratings: 2, 3, 3, 4, 5, 5, 5
Question 4: Respect for students, sensitivity to progress. Mean 3.83, median 4.5. Ratings
1, 3, 4, 5, 5, 5
Question 8: Quality of feedback. Mean 4.17, median 4.5. Ratings: 2, 4, 4, 5, 5, 5
Now, the numbers are interesting, but they don't tell me what is wrong. For example,
what could I do to make the material more clear? In what way do you feel that I lack
respect? What could I do to improve the quality of my feedback?
That is what the written response questions are for. Only one student wrote a comment
about improving the course:
"More application of lectures. Go into BlueJ more and actually show us exactly how
BlueJ will execute."
One person said that they never respond to these questions, and that if they did it would
all be BS.
However, your answers to these questions give me insight into how to improve the
course. For example, I have more labs this semester because of comments from students
in previous semesters.
pf3
pf4
pf5

Partial preview of the text

Download CSIS 110 Lecture 25: Quiz Results and Javadoc Comments - Prof. Brian F. Hanks and more Study notes Javascript programming in PDF only on Docsity!

CSIS 110 - Lecture 25

Class 22: quiz review, class 23: quiz, class 24: out of town Announcements: Next programming assignment is on the course web site. We'll begin covering the material you need for it today. Reading: 5.10 to 5. Evaluation Summary: 7 participants (10 students in class) Median: 4 or more on all questions Question 10: overall effectiveness as a teacher: mean = 4, median = 4 Question 16: course as a learning experience: mean 4.33, median 4 Mean: 4 or greater on all questions except for two. Question 2: clarity and understandability. Mean 3.86, median 4. ratings: 2, 3, 3, 4, 5, 5, 5 Question 4: Respect for students, sensitivity to progress. Mean 3.83, median 4.5. Ratings 1, 3, 4, 5, 5, 5 Question 8: Quality of feedback. Mean 4.17, median 4.5. Ratings: 2, 4, 4, 5, 5, 5 Now, the numbers are interesting, but they don't tell me what is wrong. For example, what could I do to make the material more clear? In what way do you feel that I lack respect? What could I do to improve the quality of my feedback? That is what the written response questions are for. Only one student wrote a comment about improving the course: "More application of lectures. Go into BlueJ more and actually show us exactly how BlueJ will execute." One person said that they never respond to these questions, and that if they did it would all be BS. However, your answers to these questions give me insight into how to improve the course. For example, I have more labs this semester because of comments from students in previous semesters.

Quiz Results: Mean: 17. Median: 21. Max: 23. Distribution: <10: 1 10-15: 2 15.5-20: 1 20.5+: 6 Overall excellent results! Javadoc Let's look at the Java API documentation again. Where does this all come from? Java provides a tool for generating this documentation right from your source code. The tool is called javadoc, and you can access it directly from BlueJ. javadoc generates documentation from the source code. Let's look at what it generates for our tech-support class [Tool menu โ€“ project documentation]. Seems to be missing some information

  • description of what each method does
  • description of parameters
  • description of return value We need to add some information to our source files so that javadoc can generate the appropriate documentation Special form of comment โ€“ starts with /** This signifies a javadoc comment. Placement of javadoc comments:
  • before the class declaration to describe the class
  • before a method declaration to describe the method Special tags: @version โ€“ in a class comment, to identify the version number of the class @author โ€“ in a class comment @param โ€“ in a method comment, to describe a formal parameter @return โ€“ in a method comment, to describe the return value You can also toggle from a source code view to a javadoc view directly in the BlueJ editor window โ€“ use the interface view button. public vs. private The key words public and private are access modifiers. Access modifiers define the

I don't want other classes using these methods โ€“ that would make them harder to change, also. Note that fields can also be declared as private or public. We have only seen private fields. What would happen if we declared a field as public? Other classes could change the value of fields in this method โ€“ the class would no longer be able to control its state. This is a very BAD thing, and is a very poor design. It leads to insidious bugs, makes it very difficult to maintain and read the code, and should basically never be done. User Input Validation Let's look at user input again. What want to display a prompt in the text window, and then have the user type in a response. What class do we need for this? Scanner stdin = new Scanner( System.in ); int value = stdin.nextInt(); String input = stdin.nextLine(); Let's say that we want to modify our dice program so that the user could specify the number of times to roll the dice. How would we do this? OK, now let's say that we wanted to use this input value to allocate an array. How would we do that? Oops, what's wrong? We need to validate the user input before using it. We want to make sure that the user enters a value that makes sense before we try to use it. How can we do this? We could use an if statement, and terminate the program if the user enters an invalid value. A better way would be to ask the user to enter a value again (using a conditional) The best way would be to repetitively ask the user until they enter a valid value โ€“ how could we do that? S.O.PL( "Please enter the number of times to roll the dice" ); int input = stdin.nextInt(); while ( input <= 0 ) { S.O.PL("The number must be greater than 0");

S.O.PL("Please enter the number of times to roll the dice" ); input = stdin.nextInt(); } This is called a user input validation loop. This form is very typical: Get input while ( input is invalid ) print error message get input