Documenting Attributes

I l @ ve RuBoard

Attributes should also be documented with a clear, concise definition. The definition should state the purpose of the attribute, not the structure of the attribute. For example, a bad definition for the name attribute of the Course class could be "a character string of length 15." A better definition for the name attribute is "The title of the course that is used in all University publications ."

DOCUMENTING ATTRIBUTES IN RATIONAL ROSE

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

2. Click to select the attribute.

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

The documentation for the name attribute of the Course class is shown in Figure 7-5.

Figure 7-5. Attribute Documentation

I l @ ve RuBoard