1 |
h05 |
CS56 F19 |
Name: | ||||
---|---|---|---|---|
(as it would appear on official course roster) | ||||
Umail address: | @umail.ucsb.edu | section 5pm, 6pm, 7pm |
||
Optional: name you wish to be called if different from name above. | ||||
Optional: name of "homework buddy" (leaving this blank signifies "I worked alone" |
h05: JN7 Ch7: Naming Conventions and Javadoc
ready? | assigned | due | points |
---|---|---|---|
true | Mon 10/07 05:00PM | Thu 10/10 05:00PM |
Printable PDF You may collaborate on this homework with AT MOST one person, an optional "homework buddy".
MAY ONLY BE TURNED IN IN THE LECTURE/LAB LISTED ABOVE AS THE DUE DATE,
OR IF APPLICABLE, SUBMITTED ON GRADESCOPE. There is NO MAKEUP for missed assignments;
in place of that, we drop the three lowest scores (if you have zeros, those are the three lowest scores.)
Reading Assignment: We are skipping ahead to Chapter 7 in JN7 (pp. 247-262). because the information doesn’t really depend much on the earlier chapters, and because it is so useful. There are two sections you may skip:
- Skip over the section on p. 247 about “modules”; we won’t need that yet (if at all in this course).
- You can skip from where it says “Doclets” on p. 259 to the end.
Read all the rest. You should also have the starter code for the Polynomial lab (lab04) handy when you work on this assignment, since:
- it contains many examples of Javadoc comments
- some of the questions will refer to it. You may also want to look at the formatted javadoc here: https://ucsb-cs56-f19.github.io/STAFF-lab04-dev/apidocs/
- (10 pts) Please fill in the information at the top of this homework sheet, including your name and umail address. Put the time your discussion section starts (5pm, 6pm, 7pm) in the space indicated (the one you are registered for—even if you usually attend a different one.) If the other two items apply, please fill them in as well. Please do this every single time you submit homework for this class.
-
(10 pts) What is the naming convention for packages?
-
(10 pts) What is the package name for the starter code for the Polynomial lab (lab04)?
- (5 pts) When following usual Java naming standards, as outined in JN7, class names should start with (circle one):
a lowercase letter an uppercase letter any letter - (5 pts) When following usual Java naming standards, as outined in JN7, class names should normally (circle one):
use camel case,
as inCamelCase
should use snake case, as in
Snake_Case
should use kebob case, as in
kebob-case
- (5 pts) When following usual Java naming standards, as outined in JN7, method names should start with (circle one):
a lowercase letter an uppercase letter any letter - (5 pts) What is the circumstance where you might have a series of all capital letters in a class name?
- (5 pts) When following usual Java naming standards, as outined in JN7, method names should normally (circle one):
use camel case,
as incamelCase
should use snake case, as in
snake_case
should use kebob case, as in
kebob-case
-
(5 pts) Field names (also known as attributes, or data members) should normally use the same naming convention as (circle one):
class names
method names
-
(10 pts) What is the circumstance when a field name should be in all captial letters?
-
(10 pts) What is the special syntax for the beginning and end of a java documentation comment (also called a doc comment or a javadoc comment)?
-
(10 pts) What should every javadoc comment start with?
-
(5 pts) Which javadoc tag should be in every javadoc comment for a method except when the method is void (or is a constructor as opposed to a normal method?)
-
(5 pts) Find a method in the Polynomial lab (lab04) starter code that uses either the
{@literal }
or{@code }
tags. Write the name of the method, which one ({@literal }
or{@code }
) is used, and briefly explain how it is useful in that context. You may also want to look at the formatted javadoc at this link: https://ucsb-cs56-f19.github.io/STAFF-lab04-dev/apidocs/