Login

Title

Style Matters

Course

CS1

Abstract

The goal of this assignment is to convince students that good stylistic choices in programming matters. No matter how many times you tell them this, they won't believe you until they deal with poorly written code.

Give students a piece of poorly indented/commented code, ask them to figure out what it does, and then rewrite it with proper style and good comments. Afterwards, ask them to reflect upon the difficulties created by the poor style. This is best done as a discussion after the assignment is turned in.

Author

Arup Guha

Genre

Writing Code

Assignment Duration

One Week

Communication Skill

Writing

Technical Skill

Basic Programming Skills

Workplace Scenario

You are asked to clean up someone else's code.

Team Size

N/A

Collection

Citation

Arup Guha, “Style Matters,” Incorporating Communication Outcomes into the Computer Science Curriculum, accessed September 21, 2017, http://cs-comm.lib.muohio.edu/items/show/110.

License

Creative Commons License

File: Program3-Comm.doc

File: Program3GradCrit.doc

Comments

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