https://github.com/mathworks-teaching-resources/programming-structuring-code

This curriculum module contains interactive live scripts that teach fundamental concepts and basic terminology related to programming computers. This module focuses on organizing code into functions, and describing, debugging, and sharing code.
https://github.com/mathworks-teaching-resources/programming-structuring-code

commenting debugging functions matlab matlab-live-script programming sharing-code

Last synced: 7 months ago
JSON representation

This curriculum module contains interactive live scripts that teach fundamental concepts and basic terminology related to programming computers. This module focuses on organizing code into functions, and describing, debugging, and sharing code.

• Host: GitHub
• URL: https://github.com/mathworks-teaching-resources/programming-structuring-code
• Owner: MathWorks-Teaching-Resources
• License: bsd-3-clause
• Created: 2022-08-04T19:12:57.000Z (almost 3 years ago)
• Default Branch: release
• Last Pushed: 2024-08-23T21:13:09.000Z (10 months ago)
• Last Synced: 2024-08-23T22:28:22.639Z (10 months ago)
• Topics: commenting, debugging, functions, matlab, matlab-live-script, programming, sharing-code
• Language: MATLAB
• Size: 12.7 MB
• Stars: 11
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        

# Programming: Structuring Code

[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/115905-programming-structuring-code) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=README.mlx)

[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FProgramming-Structuring-Code%2Frelease%2FImages%2FTestedWith.json)](https://MathWorks-Teaching-Resources.github.io/Programming-Structuring-Code)

**Curriculum Module**

_Created with R2024a. Compatible with R2024a and later releases._

# Information

This curriculum module contains interactive [MATLAB® live scripts](https://www.mathworks.com/products/matlab/live-editor.html) that  teach fundamental concepts and basic terminology related to programming computers. This module focuses on organizing code into functions, describing, debugging, and sharing code.

## Background

You can use these live scripts as demonstrations in lectures, class activities, or interactive assignments outside class. This module covers using built\-in and user\-defined functions, commenting code and choosing variable names, utilizing warning messages and run\-time errors to locate and fix bugs, comparing different versions of a script, cloning a GitHub repository, and creating a MATLAB project. 

The instructions inside the live scripts will guide you through the exercises and activities. Get started with each live script by running it one section at a time. To stop running the script or a section midway (for example, when an animation is in progress), use the  Stop button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.

## Contact Us

Solutions are available upon instructor request. Contact the [MathWorks teaching resources team](mailto:[email protected]) if you would like to request solutions, provide feedback, or if you have a question.

## Prerequisites

This module assumes familiarity with basic programming concepts such as floating point doubles and strings, structures including constants, vectors, matrices, and arrays, and control flows including if/else, for loops, and while loops, as well as how to use them in MATLAB. These ideas are all presented with interactive examples in [Fundamentals of Programming](https://www.mathworks.com/matlabcentral/fileexchange/103225-fundamentals-of-programming).

## Getting Started

### Accessing the Module

### **On MATLAB Online:**

Use the [](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj) link to download the module. You will be prompted to log in or create a MathWorks account. The project will be loaded, and you will see an app with several navigation options to get you started.

### **On Desktop:**

Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [StructuringCode.prj](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=README.mlx). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start. 

Ensure you have all the required products (listed below) installed. If you need to include a product, add it using the Add\-On Explorer. To install an add\-on, go to the **Home** tab and select   **Add-Ons** > **Get Add-Ons**. 

## Products

MATLAB® is used throughout, and the Symbolic Math Toolbox™ is used for the ShowTaylor example in Functions.mlx.

# Scripts

## [**Functions.mlx**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Scripts/Functions.mlx) 

|      |      |      |

| :-- | :-- | :-- |

|  | **In this script, students will...** 
  | **Summary** 
   |

|  
  | $\bullet$ use mathematical functions to use MATLAB as a calculator. 
 $\bullet$ use the documentation to locate functions and determine how to use them. 
 $\bullet$ write simple functions with inputs, outputs, and side effects, and ensure the functions are on your MATLAB path. 
 $\bullet$ pass functions as arguments by using function handles. 
  | Organizing code into functions improves the readability, reusability, and ease of testing. This script addresses built\-in functions, refactoring code to create functions, local functions, functions defined in their own files, programmatic scope and the MATLAB path, and how to pass functions as arguments to other functions. 
   |

|      |      |       |

## [**Debugging.mlx**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Scripts/Debugging.mlx) 

|      |      |      |

| :-- | :-- | :-- |

|  | **In this script, students will...** 
  | **Summary** 
   |

|  
  | $\bullet$ identify warning messages and locate and fix the problem. 
 $\bullet$ locate and fix syntax errors. 
 $\bullet$ recognize and isolate run\-time errors. 
  | Everyone makes mistakes when coding or interacting with computer programs, but you can fix these mistakes. This script introduces the MATLAB Code Analyzer, errors, warnings, breakpoints, stepping, and other tools for minimizing errors as well as identifying and removing bugs from your programs. 
   |

|      |      |       |

## [**CommentingCode.mlx**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Scripts/CommentingCode.mlx) 

|      |      |      |

| :-- | :-- | :-- |

|  | **In this script, students will...** 
  | **Summary** 
   |

|  
  | $\bullet$ write comments and documentation for a self\-defined function. 
 $\bullet$ select meaningful variable names and add code and documentation to an existing function. 
  | Clearly documenting and communicating your thinking is essential to program with others or even your future self. This script addresses why and how you should document and comment your code. 
   |

|      |      |       |

## [**SharingCode.mlx**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Structuring-Code&project=StructuringCode.prj&file=Scripts/SharingCode.mlx) 

|      |      |      |

| :-- | :-- | :-- |

|  | **In this script, students will...** 
  | **Summary** 
   |

|  
  | $\bullet$ add scripts to a project. 
 $\bullet$ clone a GitHub repository. 
 $\bullet$ use the Compare tool to see differences between two versions of the same live script  
  | Writing code for yourself is the first step, but when you create something useful or interesting, you also need to know how to share your work with others. This script offers a brief introduction to sharing your code with others. 
   |

|      |      |       |

# License

The license for this module is available in the [LICENSE.md](https://github.com/MathWorks-Teaching-Resources/Programming-Structuring-Code/blob/release/LICENSE.md).

# Related Courseware Modules

|      |      |      |

| :-- | :-- | :-- |

| **Courseware Module** 
  | **Sample Content** 
  | **Available on:** 
   |

| [**Programming: Organizing Data**](https://www.mathworks.com/matlabcentral/fileexchange/115900-programming-organizing-data) 
 Learn more about strings, numeric data types,  
 memory, and ways of storing data 
  |  
  | [](https://www.mathworks.com/matlabcentral/fileexchange/115900-programming-organizing-data) 
 [](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-Organizing-Data&project=OrganizingData.prj) 
 [GitHub](https://github.com/MathWorks-Teaching-Resources/Programming-Organizing-Data) 
   |

| [**Programming: A Starter Project Using MATLAB and Python**](https://www.mathworks.com/matlabcentral/fileexchange/116490-programming-a-starter-project-using-matlab-and-python) 
 Use MATLAB, Python, and the OpenWeather API  
 together to implement a weather prediction dashboard 
  |  
  | [](https://www.mathworks.com/matlabcentral/fileexchange/116490-programming-a-starter-project-using-matlab-and-python) 
 [](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Programming-A-Starter-Project-Using-MATLAB-and-Python&project=MATLABwithPython.prj) 
 [GitHub](https://github.com/MathWorks-Teaching-Resources/Programming-A-Starter-Project-Using-MATLAB-and-Python) 
   |

|      |      |       |

**Introductory content:**

-  [**Fundamentals of Programming**](https://www.mathworks.com/matlabcentral/fileexchange/103225-fundamentals-of-programming) is available on [](https://www.mathworks.com/matlabcentral/fileexchange/103225-fundamentals-of-programming) or [](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Fundamentals-of-Programming&project=FundamentalsofProgramming.prj) or [GitHub](https://github.com/MathWorks-Teaching-Resources/Fundamentals-of-Programming) 

-  [**Treasure Hunt Game: Learn to Code**](https://www.mathworks.com/matlabcentral/fileexchange/123265-treasure-hunt) is available on [](https://www.mathworks.com/matlabcentral/fileexchange/123265-treasure-hunt) or [](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Treasure-Hunt&project=TreasureHunt.prj) or [GitHub](https://github.com/MathWorks-Teaching-Resources/Treasure-Hunt) 

Or feel free to explore our other [modular courseware content](https://www.mathworks.com/matlabcentral/fileexchange/?q=tag%3A%22courseware+module%22&sort=downloads_desc_30d).

# Educator Resources

-  [Educator Page](https://www.mathworks.com/academia/educators.html) 

# Contribute 

Looking for more? Find an issue? Have a suggestion? Please contact the [MathWorks teaching resources team](mailto:%[email protected]). If you want to contribute directly to this project, you can find information about how to do so in the [CONTRIBUTING.md](https://github.com/MathWorks-Teaching-Resources/Programming-Structuring-Code/blob/release/CONTRIBUTING.md) page on GitHub.

 *©* Copyright 2024 The MathWorks™, Inc