Tools

This page describes some software tools we’ll be using and learning this term. Most of the stuff is open source. Most of it is very nice as well. enjoy... yow, bill

If you know C++, but you don’t know Java, then we have something in common. I used to be in your shoes. Here are my thoughts on your transition: http://william.krieger.faculty.noctrl.edu/dry_technical_notes/dtn04_java_for_c++.htm

Java is available on all the machines in the lab. If you want to download a copy for your home:

• Go to: http://java.sun.com/
• Click on Java SE under “Popular Downloads”
• Download “JDK 6u1 with NetBeans 5.5” for Windows... it’s about a 140MB download and snarfs about 450MB on your machine once installed

You also get NetBeans in your Java download. NetBeans is Sun Micro’s IDE... it’s now open source. NetBeans is huge, but OK. We’ll start it up in class to get you going. From there, it’s mostly just getting your sea legs.

• NetBeans has its own web site at: http://www.netbeans.org/
• Here’s a cool page of tutorials for NetBeans: http://www.javapassion.com/netbeans/masterindex.html
• A NetBeans wiki: http://wiki.netbeans.org/wiki/

Javadoc will ease your goal of creating quality documentation of your code. The entire Java API uses Javadoc.

• Here’s Sun’s description: http://java.sun.com/j2se/javadoc/
• Javadoc is plugged into NetBeans... try the Build/Generate Javadoc menu

Listen, this stuff is popular and powerful because it’s so simple:

1. Javadoc comments look like this: /*\\* comment in here */
2. Each class, method and data field in your code should have a Javadoc document
3. We’ll use the following tags: @param, @return, @author
4. I’ll put an example in the k: drive

Ant is a tool to help build your programs: compile, link, etc.

• Web site: http://ant.apache.org/
• Here’s a nice Ant tutorial: http://ideoplex.com/focus/java

Ant is used by NetBeans as well.

JUnit aids unit testing your code.

• Web site: http://www.junit.org/index.htm
• And here: http://junit.sourceforge.net/
• I found this nice tutorial surfing: http://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/junit/junit.html
• This one’s so good, it’s a handout: http://junit.sourceforge.net/doc/testinfected/testing.htm

CheckStyle scans your Java code and reports

• Web site: http://checkstyle.sourceforge.net/
• There’s a separate NetBeans plug-in as well: http://nbcheckstyle.sourceforge.net/

I used the Sun CheckStyle rules, and man is it cranky. We’ll have to work on what rules we want to apply for CSC 457.

Here are some CSC 457-specific programming requirements:

1. Our class coding guidelines are here: http://william.krieger.faculty.noctrl.edu/dry_technical_notes/dtn03_coding_guidelines.htm
2. Start your programs early. I will set intermediate goals for each program.
3. Do not leave documentation (Javadoc) and testing (JUnit) until the end. Our 457 programs are not difficult. We are doing them to experience software development with a little higher level of commitment to creating quality code.
4. Communicate! It’s OK to talk/email to me, your friends and your classmates about your coding woes. You can’t share code, but sharing problems and solutions is fine.
5. If you don’t know Java and don’t have a book, then please get one. I’ll help you choose if you like.