4.2. Getting Started

Learn by Experimenting

For each of the remaining sections in this chapter, be sure to login to Odin and type out the commands given in each part, taking notes as needed. When you are done, you will have a step-by-step outline for creating and using interfaces in Java. Your notes and will be very useful on upcoming homework assignments and projects.

As you work through this example, you will see how to write Javadoc comments and create API documentation for existing code. Then, you will host that documentation on your personal website on Odin.

On Odin, complete each of the following steps:

1. Use the following command to download the starter code for this chapter and place it into a subdirectory called cs1302-javadoc:

   curl -s -L https://raw.githubusercontent.com/cs1302uga/cs1302-tutorials/alsi/javadoc/setup.sh | bash
   

2. Change into the cs1302-javadoc directory that was just created and look around. There should be a Java file contained within the directory structure. To see a listing of all of the files under the current directory, use the tree command.

   You should see a single .java file in the output of tree. Take a few minutes to explore the provided code. You will notice that some of the code contains Javadoc comments that begin with /** instead of /*. These are known as Javadoc comments, and they are used to provide API documentation in Java. Some comments have been purposefully omitted so that you can write them yourself later in this tutorial.

   For more information on the format of Javadoc comments and the various tags that are supported, see [JAVADOC].