Documenting Operations

I l @ ve RuBoard

Each operation should be documented so the reader of the model can quickly understand its purpose. The documentation should state the functionality performed by the operation. It should also state any input values needed by the operation along with the return value of the operation. The input and return values constitute the operation signature. This information may not be known initially. Instead, it may be added later in the life cycle when more is known about the class.

DOCUMENTING OPERATIONS IN RATIONAL ROSE

1. Click the + next to the class in the browser to expand the class.

2. Click to select the operation.

3. Position the cursor in the documentation window and enter the documentation for the operation.

The documentation for the setProfessor() operation of the Course class is shown in Figure 7-3.

Figure 7-3. Operation Documentation

I l @ ve RuBoard