Login

Title

Implementing and documenting a class

Course

Data Structures

Abstract

In this assignment, the student will implement a class and use the doxygen documentation facility to document it. Javadocs can also be used if java is the preferred language. The assignment is written for a specific class to be implemented in the context of a larger project and should be modified to account for using other classes or project.

Author

Gerald Gannod

Genre

comments, documentation, code

Assignment Duration

One Week

Communication Skill

writing

Technical Skill

implementation, coding

Workplace Scenario

Scenario: You have been assigned the task of both writing and documenting the behavior of a class.

Communication Audience: Other developers and potential maintainers

Deliverables: Source code with embedded comments plus generated html documentation of the source

How it will be used: The documentation will be used to understand how to use the code

Team Size

N/A

Collection

Citation

Gerald Gannod, “Implementing and documenting a class,” Incorporating Communication Outcomes into the Computer Science Curriculum, accessed November 19, 2017, http://cs-comm.lib.muohio.edu/items/show/71.

License

Creative Commons License

File: ClassDocumentationwithDoxygen.doc

Comments

Allowed tags: <p>, <a>, <em>, <strong>, <ul>, <ol>, <li>