Software Design and Development :: CS 246

11 Teach : Team Activity

Javadoc in Android

Objectives

• Add some Javadoc comments to your project.

• Use the Javadoc tool to generate documentation based on your Javadoc comments.

Overview

This week you'll use the Javadoc system to add comments to your project code.

Instructions

The following steps will guide you through this process.

Part I - Plan what you need to document and write the Javadoc comments.

1. Brainstorm with your team where you should have Javadoc comments. Typically, every class you create, and every public function should have a Javadoc comment. Some protected and private functions should also have Javadoc comments.

2. Write the Javadoc code for those functions and classes, following the guidelines in the Google Java Style Guide.

Part II - Use the Javadoc tool to generate your documentation files.

1. Follow these instructions to generate the Javadoc output for your project.

2. If you want to exclude the built-in R object and BuildConfig classes, see this Stack Overflow post.

Congratulations! You now know how to create Javadoc comments and use them to generate code documentation.

Make sure to complete the accompanying quiz for this assignment on I-Learn.