CSC/ECE 517 Spring 2023 - E2320. Reimplement the Question Hierarchy: Difference between revisions
Jump to navigation
Jump to search
m (→Plan of work) |
|||
| Line 12: | Line 12: | ||
===Design Goals=== | ===Design Goals=== | ||
* Update code comments - | * Update code comments - Some methods and classes currently do not have any code comments, while other comments are not in depth enough to give proper context for functionality. One of our design goals will be to write more in depth comments that better explain functionality for the code. | ||
* DRY out code with partials - Implement additional partials for certain classes. Ex: Question_Controller | * DRY out code with partials - Implement additional partials for certain classes. Ex: Question_Controller | ||
Revision as of 22:05, 5 April 2023
Design Doc
Statement Problem
Explanation of Feature
List of Work Done so Far
Plan of work
Based on the feedback provided to us by both our mentors and also peer reviews our team has decided upon a few key design goals to work on for the continuation of our work into Program 4. These goals are outlined below.
Design Goals
- Update code comments - Some methods and classes currently do not have any code comments, while other comments are not in depth enough to give proper context for functionality. One of our design goals will be to write more in depth comments that better explain functionality for the code.
- DRY out code with partials - Implement additional partials for certain classes. Ex: Question_Controller
Tests
Conclusions / Future Work
Specific Tasks Completed
[Will be updated near final submission deadline]