http://cs-comm.lib.muohio.edu/items/browse/tag/API+documentation?output=atom <![CDATA[Incorporating Communication Outcomes into the Computer Science Curriculum]]> The dissemination of the project's research will come with the creation of a repository that allows CSE faculty members to access a web-based set of assignments. The goal of these assignments is to aid CSE faculty in redesigning their assignments, courses, and curricula in order to incorporate and enhance their students abilities to communicate and collaborate with a wide variety of audiences. The repository will be populated with assignments written and designed by both CSE and CAC faculty with the premise of integrating communication abilities while also enhancing the learning of the technical content being taught in their course and/or curriculum.

]]> 2020-05-18T19:23:34-04:00 Omeka http://cs-comm.lib.muohio.edu/items/show/81 <![CDATA[Using the Java API documentation to solve a problem]]>


This is best suited to students who have only a basic knowledge of Strings and their methods, as it then forces them to dig around in the API documentation for Strings in order to find methods that accomplish their goals.]]> 2012-07-26T11:04:41-04:00

Title

Using the Java API documentation to solve a problem

Course

CS1

Abstract

This is an assignment focused on using Java API documentation to find methods that aid in solving a problem. In it, students must write a program that parses text and "cleans it up" (in particular: a name, address, and phone number, entered in a sloppy way by a user).

This is best suited to students who have only a basic knowledge of Strings and their methods, as it then forces them to dig around in the API documentation for Strings in order to find methods that accomplish their goals.

Author

Norm Krumpe

Genre

API documentation

Assignment Duration

One Week

Communication Skill

reading, writing

Technical Skill

Programming language basics

Workplace Scenario

The software you will write almost always depends on making use of packages, classes, and methods that were developed by other programmers. In order to use software written by others, it is necessary to be able to navigate and understand the documentation for that software.

In this assignment, you will need to solve a programming problem that requires you to use methods you have not seen or used before. You will produce a program that performs some fairly sophisticated parsing of Strings...parsing that is difficult to perform without first navigating the available methods in the String class.

When you are finished, you will report to your instructor on the methods that you used to solve the problem.

Team Size

N/A
]]> http://cs-comm.lib.muohio.edu/items/show/67 <![CDATA[Reading and Using API Documentation]]>
Many of the code-writing questions depend on using the Dr. Java to type out and test code. Dr. Java's "Interactions Pane" allows quick testing of individual lines of code, without the need to write a class and method to test that code.

Dr. Java is freely available from http://drjava.org. Regardless of the IDE you prefer to use in your class, Dr. Java is easy to use, if only for this assignment.]]> 2012-07-26T11:38:22-04:00

Title

Reading and Using API Documentation

Course

CS1

Abstract

Effective programming involves being able to navigate API documentation for various packages and classes, in order to identify an appropriate class/method/constructor to solve the problem at hand. This activity focuses on reading Java's API documentation to learn about classes that are unfamiliar to the student. It contains questions that can only be answered by digging around in the documentation. As they navigate the documentation, students will write short bits of code that demonstrate their understanding of that documentation.

Many of the code-writing questions depend on using the Dr. Java to type out and test code. Dr. Java's "Interactions Pane" allows quick testing of individual lines of code, without the need to write a class and method to test that code.

Dr. Java is freely available from http://drjava.org. Regardless of the IDE you prefer to use in your class, Dr. Java is easy to use, if only for this assignment.

Author

Norm Krumpe

Genre

Navigating API documentation

Assignment Duration

Laboratory

Communication Skill

reading

Technical Skill

Coding

Workplace Scenario

The software you will write almost always depends on making use of packages, classes, and methods that were developed by other programmers. In order to use software written by others, it is necessary to be able to navigate and understand the documentation for that software.

In this assignment, you will navigate the Java API Documentation, and use it to learn about Java packages and classes you probably haven't seen before. You will read about classes and methods, and then write short pieces of Java code that use those classes and methods.

After completing this activity, you should be able to:

• Navigate through and read parts of Java's API documentation to find descriptions and specifications of classes, methods, and constructors.

• Solve small programming problems by using new classes, methods, and constructors that you learn about in the Java API documentation

Team Size

N/A
]]> http://cs-comm.lib.muohio.edu/items/show/17 <![CDATA[Writing Javadoc Comments for a Class]]>
This assignment assumes that students are able to implement a basic class definition in Java, with constructors, getters, and setters.]]> 2012-07-26T11:08:16-04:00

Title

Writing Javadoc Comments for a Class

Course

CS1

Abstract

This assignment combines implementing a class definition (constructors, getters, setters for a Rectangle) with using Javadoc comments to document the class. This assignment includes background information on the Javadoc tool, including information about technical requirements (such as the @param tag) and style guidelines for javadocs (guidelines nicely summarized on Oracle's website). The rubric includes separate items for both the technical part of the assignment (writing the class) and the Javadoc part of the assignment. This could be easily modified to incorporate Javadocs with some other programming assignment.

This assignment assumes that students are able to implement a basic class definition in Java, with constructors, getters, and setters.

Author

Norm Krumpe

Genre

Javadocs

Assignment Duration

One Week

Communication Skill

Writing

Technical Skill

Class creation, documentation

Workplace Scenario

Organizations write code that must be sufficiently documented in order for other team members (current and future) to use that code. Often, such documentation must be written using a given set of requirements (as defined by an employer or by some broader community).

In this assignment, you will be writing code, along with the documentation for that code. There are two kinds of standards for that documentation:

  1. Technical standards: the documentation you write needs to be parsable by a piece of software that turns your comments into a web page. The Javadoc standards are documented on Oracle's web page, "How to Write Doc Comments for the Javadoc Tool"
  2. Human standards: the documentation you write needs to be written in a grammatic style that is consistent with how others write similar documentation. The community style for these standards is documented on the same Oracle web page, in the "Style Guide" section.

Team Size

N/A
]]>