Skip to content

Commit 887f850

Browse files
authored
Add files via upload
1 parent aee81be commit 887f850

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# MATLAB Coding Guidelines
2+
3+
This repository contains a set of recommended MATLAB Coding Guidelines. These guidelines have been developed primarily for large organizations or teams of MATLAB developers who want to introduce some degree of regularity and consistency in their MATLAB code bases. Use of the guidelines is optional.
4+
5+
The guidelines contain Rules and Best Practices. _Rules_ must be followed in order to comply with the guidelines. Rule violations are detected by the MATLAB Code Analyzer and identified in the MATLAB Editor and in the Code Analyzer report. Each version of the guidelines is accompanied by a `codeAnalyzerConfiguration.json` file which contains the checks used by the Code Analyzer to detect Rule violations.
6+
7+
_Best Practices_ are guidelines that contain recommendations for improving the quality of your MATLAB code. Following them is optional. Some Best Practices can (optionally) be detected as Rules by enabling a check in the Code Analyzer. The introductory material in the guidelines document explains Rules and Best Practices in more detail.
8+
9+
Each folder in this repo contains a version of the coding guidelines. Download the latest version of the guidelines that corresponds to your version of MATLAB as indicated in the following table.
10+
11+
| **Use guidelines version** | **With MATLAB version** |
12+
| -------------------------- | ----------------------- |
13+
| Version 1.0 | R2025a and higher |
14+
15+
The contents of each folder is as follows.
16+
17+
- codeAnalyzerConfiguration.json
18+
- MATLAB Coding Guidelines.md
19+
- MATLAB Coding Guidelines.pdf
20+
- RevisionHistory.txt
21+
22+
The guidelines are expected to evolve over time driven by feedback from the MATLAB community. We encourage your feedback and suggestions for future revisions. Feel free to open an issue or post to the discussions. Your insights and feedback help us improve this document and make it even more useful for the community.
23+
24+
You may use the guidelines document and the related codeAnalyzerConfiguration.json file as a starting point to create your own local guidelines to meet the specific needs of your organization.

0 commit comments

Comments
 (0)