You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 03923e1
Browse filesBrowse the repository at this point in the historyBrowse files
contains the same information but in a browsable format. If you don’t
17
-
know the class name exactly this is a good way to see what is close.</p>
18
-
</li>
19
-
</ul>
20
-
</p>
21
-
<p>In general the Javadoc page for any class contains information about:</p>
22
-
<p>
23
-
<ul>
24
-
<li>
25
-
<p>Where this class falls in the class hierarchy. What classes are its
26
-
parents and what classes are its decendents.</p>
27
-
</li>
28
-
<li>
29
-
<p>A summary and some examples of using the class.</p>
30
-
</li>
31
-
<li>
32
-
<p>A summary listing of instance variables</p>
33
-
</li>
34
-
<li>
35
-
<p>A summary listing of Constructors</p>
36
-
</li>
37
-
<li>
38
-
<p>A summary listing of Methods</p>
39
-
</li>
40
-
<li>
41
-
<p>Detailed documentation on constructors and methods.</p>
42
-
</li>
43
-
</ul>
44
-
</p>
45
-
<p>Typically the Javadoc pages are constructed from the source code where
46
-
the class is implemented. This encourages Java programmers to do a good
47
-
job of documenting their code, while providing a user friendly way to
48
-
read the documentation without looking at the code directly.</p>
49
-
</chapter>
5
+
<title>Java Documentation</title>
6
+
7
+
<p>
8
+
All Java class libraries are documented and available online.
9
+
Here are two good resources for you to use:
10
+
</p>
11
+
12
+
<p>
13
+
<ul>
14
+
<li>
15
+
<p>
16
+
<urlhref="http://www.javadoconline.com"visual="http://www.javadoconline.com">JavaDoc</url> The Javadoconline website provides a nice searchable interface. Search for a classname and you will get the documentation you are looking for.
17
+
</p>
18
+
</li>
19
+
20
+
<li>
21
+
<p>
22
+
<urlhref="http://knuth.luther.edu/Javadoc/docs/api/index.html"visual="http://knuth.luther.edu/Javadoc/docs/api/index.html">JavaAPI</url> contains the same information but in a browsable format. If you don’t know the class name exactly this is a good way to see what is close.
23
+
</p>
24
+
</li>
25
+
</ul>
26
+
</p>
27
+
28
+
<p>
29
+
In general the Javadoc page for any class contains information about:
30
+
</p>
31
+
32
+
<p>
33
+
<ul>
34
+
<li>
35
+
<p>
36
+
Where this class falls in the class hierarchy.
37
+
What classes are its parents and what classes are its decendents.
38
+
</p>
39
+
</li>
40
+
41
+
<li>
42
+
<p>
43
+
A summary and some examples of using the class.
44
+
</p>
45
+
</li>
46
+
47
+
<li>
48
+
<p>
49
+
A summary listing of instance variables
50
+
</p>
51
+
</li>
52
+
53
+
<li>
54
+
<p>
55
+
A summary listing of Constructors
56
+
</p>
57
+
</li>
58
+
59
+
<li>
60
+
<p>
61
+
A summary listing of Methods
62
+
</p>
63
+
</li>
64
+
65
+
<li>
66
+
<p>
67
+
Detailed documentation on constructors and methods.
68
+
</p>
69
+
</li>
70
+
</ul>
71
+
</p>
72
+
73
+
<p>
74
+
Typically the Javadoc pages are constructed from the source code where the class is implemented.
75
+
This encourages Java programmers to do a good job of documenting their code, while providing a user friendly way to read the documentation without looking at the code directly.
<p>This book assumes that you are already familiar with the
6
-
<urlhref="http://www.python.org"visual="http://www.python.org">Python</url> programming language. We will use
7
-
Python as a starting point for our journey into
8
-
<urlhref="http://java.sun.com"visual="http://java.sun.com">Java</url>. We will begin by looking at a very simple
9
-
Java program, just to see what the language looks like and how we get a
10
-
program to run. Next, we will look at the main constructs that are
11
-
common to most programming languages:</p>
12
-
<blockquote>
5
+
<title>Introduction</title>
6
+
13
7
<p>
14
-
<ul>
15
-
<li>
16
-
<p>Data Types</p>
17
-
</li>
18
-
<li>
19
-
<p>Loops</p>
20
-
</li>
21
-
<li>
22
-
<p>Reading user input</p>
23
-
</li>
24
-
<li>
25
-
<p>Conditionals</p>
26
-
</li>
27
-
</ul>
8
+
This book assumes that you are already familiar with the <urlhref="http://www.python.org"visual="http://www.python.org">Python</url> programming language.
9
+
We will use Python as a starting point for our journey into <urlhref="http://java.sun.com"visual="http://java.sun.com">Java</url>.
10
+
We will begin by looking at a very simple Java program, just to see what the language looks like and how we get a program to run.
11
+
Next, we will look at the main constructs that are common to most programming languages:
28
12
</p>
29
-
</blockquote>
30
-
<p>Once we have the basics of Java behind us we will move on to look at the
31
-
features of Java that are both unique and powerful.</p>
32
-
<blockquote>
13
+
14
+
<blockquote>
15
+
<p>
16
+
<ul>
17
+
<li>
18
+
<p>
19
+
Data Types
20
+
</p>
21
+
</li>
22
+
23
+
<li>
24
+
<p>
25
+
Loops
26
+
</p>
27
+
</li>
28
+
29
+
<li>
30
+
<p>
31
+
Reading user input
32
+
</p>
33
+
</li>
34
+
35
+
<li>
36
+
<p>
37
+
Conditionals
38
+
</p>
39
+
</li>
40
+
</ul>
41
+
</p>
42
+
</blockquote>
43
+
33
44
<p>
34
-
<ul>
35
-
<li>
36
-
<p>Classes</p>
37
-
</li>
38
-
<li>
39
-
<p>Interfaces</p>
40
-
</li>
41
-
<li>
42
-
<p>Collections</p>
43
-
</li>
44
-
<li>
45
-
<p>Graphical User Interface Programming</p>
46
-
</li>
47
-
<li>
48
-
<p>Generic Programming</p>
49
-
</li>
50
-
</ul>
45
+
Once we have the basics of Java behind us we will move on to look at the features of Java that are both unique and powerful.
51
46
</p>
52
-
</blockquote>
53
-
<p>Please note that this book is a work in progress. I will continue to
0 commit comments