Intro to Style Guides (Activity)
(Difference between revisions)
| Line 6: | Line 6: | ||
|'''Overview''' || In this activity you will learn about why we need a style guide for team-based projects and compare style guides for a various projects. Based on this experience, you will develop a style guide for your team. | |'''Overview''' || In this activity you will learn about why we need a style guide for team-based projects and compare style guides for a various projects. Based on this experience, you will develop a style guide for your team. | ||
|- | |- | ||
| − | |'''Prerequisite Knowledge''' || | + | |'''Prerequisite Knowledge''' || |
|- | |- | ||
|'''Learning Objectives''' || Upon completion of this activity, you will be able to: | |'''Learning Objectives''' || Upon completion of this activity, you will be able to: | ||
| Line 18: | Line 18: | ||
=== Directions: === | === Directions: === | ||
| + | |||
| + | In-class activity: | ||
| + | |||
| + | * look at three versions of the same code | ||
| + | ** which do you like best? worst? why? | ||
| + | * discuss consistency of code | ||
| + | |||
=== Deliverables: === | === Deliverables: === | ||
Revision as of 21:23, 26 May 2015
| Title | The Need for Style Guides |
| Overview | In this activity you will learn about why we need a style guide for team-based projects and compare style guides for a various projects. Based on this experience, you will develop a style guide for your team. |
| Prerequisite Knowledge | |
| Learning Objectives | Upon completion of this activity, you will be able to:
|
Background:
Directions:
In-class activity:
- look at three versions of the same code
- which do you like best? worst? why?
- discuss consistency of code
Deliverables:
Assessment:
Comments:
Additional Information:
| Knowledge Area/Knowledge Unit | |
| Topic | |
| Level of Difficulty | |
| Estimated Time to Completion | |
| Materials/Environment | |
| Author | |
| Source | |
| License |
Suggestions for the Open Source Project:
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License
