Document Code with Meaningful Comments (Activity)
From Foss2Serve
(Difference between revisions)
| (18 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | __NOTOC__ | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | {{Learning Activity Overview | |
| − | | | + | |title= |
| − | | | + | Document Code with Meaningful Comments |
| − | + | |overview= | |
| − | | | + | In this activity, students will define what "meaningful comments" mean and create a rubric for it. |
| − | + | Then, they will create meaningful comments for a given source file with undocumented code. | |
| − | | | + | |prerequisites= |
| − | + | The instructor can tailor this activity to match the current content being taught in a CS 2 course. Therefore it could be appropriate at any time during the CS 2 course. | |
| − | + | |objectives= | |
| − | + | Students should define “meaningful comments”. They will create a rubric for this. | |
| − | | | + | Each team will make use of this rubric when commenting/documenting the second source file. |
| − | + | |process skills= | |
| + | }} | ||
| − | + | === Background === | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | === Background | + | |
CS 1 background should suffice. | CS 1 background should suffice. | ||
| − | + | Some possible reading the instructors only (students should discover the idea of "meaningful comments"!): | |
| − | + | ||
| − | - | + | * http://blog.codinghorror.com/coding-without-comments/ |
| + | * http://improvingsoftware.com/2011/06/27/5-best-practices-for-commenting-your-code/ | ||
| + | * http://www.hongkiat.com/blog/source-code-comment-styling-tips/ | ||
| + | * http://en.wikipedia.org/wiki/Comment_%28computer_programming%29 | ||
| + | * http://javarevisited.blogspot.com/2011/08/code-comments-java-best-practices.html | ||
| + | * http://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code--net-8118 | ||
| − | + | === Directions === | |
| − | - Teams will then be asked to write comments for the given code. | + | # The entire class will be given a brief overview of a project. This can be chosen from the existing HFOSS projects that contain source files in the programming language used in the course. |
| + | # Then the class will be split in teams of 2-3 students, and each team will be given one file of undocumented code that has an easy complexity level. Several teams will have the same assigned code! | ||
| + | # Teams will then be asked to write comments for the given code. | ||
| + | # Then, in class, students will present their work and define "meaningful comments". While presenting, based on students' reflections, the instructor will create a rubric to assess when a code has meaningful comments and when it does not. | ||
| + | # Then, each team will be assigned a second file with undocumented code and they will be asked to write "meaningful comments". The students will meet again in one week and will have to present their work. | ||
| − | + | * All the students will have access to the entire project in case they want to look at the big picture while commenting the code. Depending on the complexity level, this may be a must have. | |
| + | * During the presentation, the other teams will assess each team's work using the rubric created in the first phase. | ||
| + | * If time is available, it may be useful to compare the "meaningful comments" of students with the original comments existing in the code (but which was not made available to students). | ||
| − | + | === Deliverables === | |
| − | + | * A rubric that can be used to assess "meaningful comments" | |
| + | * Code with "meaningful comments" will be presented to the entire class. | ||
| − | + | === Assessment === | |
| + | === Comments === | ||
| − | + | === Additional Information: === | |
| − | + | {{Learning Activity Info | |
| − | + | |acm unit= | |
| + | Coding & Style | ||
| + | |acm topic= | ||
| + | Meaningful Comments | ||
| + | |difficulty= | ||
| + | Medium/Hard | ||
| + | |time= | ||
| + | A total of 120 minutes is suggested. | ||
| + | The first part can be done in class, while the second part can be given as a week-long project and then in another class period each team will have to present their code. | ||
| + | All students will rate (based solely on the comments) the readability of the code being presented by each team. | ||
| + | |environment= | ||
| + | Each team will be given three materials: | ||
| + | * a source file of a (more or less) complete project without any comments | ||
| + | * a file with an easy code to understand and document | ||
| + | * a file with a medium/hard code to understand and document | ||
| + | |author= | ||
| + | Razvan A. Mezei | ||
| + | |source= | ||
| + | 50 Ways | ||
| + | |license= | ||
| + | {{License CC BY SA}} | ||
| + | }} | ||
| − | + | === Suggestions for the Open Source Project: === | |
| − | [[Category: Learning_Activity]] | + | [[Category:Learning_Activity]] |
| − | [[Category: | + | [[Category:Coding and Style]] |
| + | [[Category:Documentation]] | ||
| + | [[Category:CS1]] | ||
| + | [[Category:CS2]] | ||
| + | [[Category:Minimal Sketch]] | ||
Latest revision as of 22:04, 7 September 2018
| Title |
Document Code with Meaningful Comments |
|---|---|
| Overview |
In this activity, students will define what "meaningful comments" mean and create a rubric for it. Then, they will create meaningful comments for a given source file with undocumented code. |
| Prerequisites |
The instructor can tailor this activity to match the current content being taught in a CS 2 course. Therefore it could be appropriate at any time during the CS 2 course. |
| Learning Objectives |
After successfully completing this activity, the learner should be able to:
Students should define “meaningful comments”. They will create a rubric for this. Each team will make use of this rubric when commenting/documenting the second source file. |
| Process Skills Practiced |
Background
CS 1 background should suffice.
Some possible reading the instructors only (students should discover the idea of "meaningful comments"!):
- http://blog.codinghorror.com/coding-without-comments/
- http://improvingsoftware.com/2011/06/27/5-best-practices-for-commenting-your-code/
- http://www.hongkiat.com/blog/source-code-comment-styling-tips/
- http://en.wikipedia.org/wiki/Comment_%28computer_programming%29
- http://javarevisited.blogspot.com/2011/08/code-comments-java-best-practices.html
- http://code.tutsplus.com/tutorials/top-15-best-practices-for-writing-super-readable-code--net-8118
Directions
- The entire class will be given a brief overview of a project. This can be chosen from the existing HFOSS projects that contain source files in the programming language used in the course.
- Then the class will be split in teams of 2-3 students, and each team will be given one file of undocumented code that has an easy complexity level. Several teams will have the same assigned code!
- Teams will then be asked to write comments for the given code.
- Then, in class, students will present their work and define "meaningful comments". While presenting, based on students' reflections, the instructor will create a rubric to assess when a code has meaningful comments and when it does not.
- Then, each team will be assigned a second file with undocumented code and they will be asked to write "meaningful comments". The students will meet again in one week and will have to present their work.
- All the students will have access to the entire project in case they want to look at the big picture while commenting the code. Depending on the complexity level, this may be a must have.
- During the presentation, the other teams will assess each team's work using the rubric created in the first phase.
- If time is available, it may be useful to compare the "meaningful comments" of students with the original comments existing in the code (but which was not made available to students).
Deliverables
- A rubric that can be used to assess "meaningful comments"
- Code with "meaningful comments" will be presented to the entire class.
Assessment
Comments
Additional Information:
| ACM BoK Area & Unit(s) |
Coding & Style |
|---|---|
| ACM BoK Topic(s) |
Meaningful Comments |
| Difficulty |
Medium/Hard |
| Estimated Time to Complete |
A total of 120 minutes is suggested. The first part can be done in class, while the second part can be given as a week-long project and then in another class period each team will have to present their code. All students will rate (based solely on the comments) the readability of the code being presented by each team. |
| Environment / Materials |
Each team will be given three materials:
|
| Author(s) |
Razvan A. Mezei |
| Source |
50 Ways |
| License |
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License
|
