Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Class Definition Document #39

Closed
shawncrook411 opened this issue Feb 19, 2025 · 0 comments
Closed

Class Definition Document #39

shawncrook411 opened this issue Feb 19, 2025 · 0 comments
Assignees

Comments

@shawncrook411
Copy link
Collaborator

Describe all of the classes in your project, including interfaces, base classes, and abstract classes. Make sure your class design is properly modular with loose coupling (i.e. no user interface code in the data model classes or "business logic" classes). Proper class design should also make sure classes are divided appropriately without one class becoming too big or unwieldy. (If you have a class that has more than five fields and/or ten functions it is probably a good candidate to subdivide into multiple classes). In your document, each class should have additional documentation for the following: purpose of the class, purpose of each function, description of any input parameters for the function, description of return value (if any), pre- and post-conditions for the function. Remember you can use LucidChart as described in the class video as a handy tool to create a UML class diagram for this requirement (but not necessary).

@shawncrook411 shawncrook411 self-assigned this Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant