Code Review and Documentation in a C++ Repository on GitHub

Material Category: Learning Activity
Course Categories: CS1/CS2/Data Structures |
FOSS Categories: Coding & Style | Documentation |
Tags: C++ | code review | GitHub |

Overview:

Students explore an open source project (QGIS, also known as Quantum GIS), hosted on GitHub, and answer a few questions about its meta-data. They are asked to read the implementation of its priority queue class, which has no documentation, and to write contract-style comments for the member functions in the interface file for that class.

Link: http://www.compsci.hunter.cuny.edu/~sweiss/course_materials/csci335/assignments/assignment03.pdf

Source: This is an exercise I developed myself. (Stewart Weiss)


Return to Teaching Materials

Leave a Reply