2.5. Code Structure and Documentation

Try these first

1. 1.

   What is the primary benefit of modular programming?

   Hint

   Think about how functions can be called multiple times.

2. 2.

   What should be included in a README file?

   Hint

   It’s like an introduction to your project.

3. 3.

   What is a key feature of advanced programming in terms of code structure?

   • Linear format
   • Modular architecture
   • Single file

   Hint

   Think about reusability and organization in code.

4. 4.

   True or False: Documentation is less important in advanced programming than in basic programming.

   • True
   • False

   Hint

   Consider how teams work on larger projects.

5. 5.

   Create a small project in a programming language of your choice. Structure your code using modular design principles and include a README file documenting your code functionalities. How would you ensure the readability of your code?

   Hint

   Focus on how you would write code so others can quickly understand it.

6. 6.

   Review a sample code base with inadequate documentation. Identify at least three aspects of the code that demonstrate poor documentation practices and suggest specific improvements.

   Hint

   Think critically about what makes code easier to understand.