shCode

Module 1.3 — Documentation and Coding Conventions

Quarter 1 · Weeks 3 · Environment: console

Lessons in this module

Estimated: ~3 hr 58 min

  1. Slides1.3.1Slides — Documentation and Coding Conventions~5 min
  2. Reading1.3.2Reading — camelCase Naming Style~5 min
  3. Reading1.3.3Reading — Code Layout~5 min
  4. Reading1.3.4Reading — Comments: // and /* */~10 min
  5. Reading1.3.5Reading — Why Documentation Matters~8 min
  6. Reading1.3.6Reading — Human-Readable Names~10 min
  7. Reading1.3.7Reading — Avoid Single Letters and Abbreviations~10 min
  8. Reading1.3.8Reading — Descriptive but Concise~10 min
  9. Reading1.3.9Reading — Agree on Terms~10 min
  10. Worked Example1.3.10Worked Example — Good vs Bad Names~10 min
  11. Assignment1.3.11Rename the Mystery Variables~15 min
  12. Assignment1.3.12Rate These Names~15 min
  13. Reading1.3.13Reading — Reuse or Create?~10 min
  14. Reading1.3.14Reading — What Reuse Actually Costs~10 min
  15. Worked Example1.3.15Worked Example — One Variable, Three Meanings~10 min
  16. Assignment1.3.16Split the Reused Variable~15 min
  17. Assignment1.3.17Team Vocabulary~15 min
  18. Reading1.3.18Reading — What a README Is For~10 min
  19. Assignment1.3.19Document a Messy Program~40 min
  20. Video1.3.20Video — Names Are for Readers~5 min
  21. Quiz1.3.21Module 1.3 Quiz~10 min