MATLAB AI Coding Rules

# MATLAB AI Coding Rules

MATLAB coding rules and guidelines for AI coding assistants like Cursor, Windsurf, Claude Code, and GitHub Copilot.

## Overview

Rule files for AI coding assistants to generate MATLAB code that follows coding standards.

## Available Rules

### [matlab-coding-standards.md](matlab-coding-standards.md)
Comprehensive MATLAB coding standards covering:
- Naming conventions for variables, functions, classes, and properties
- Statement and expression guidelines
- Formatting rules and whitespace conventions
- Function and class authoring best practices
- Error handling patterns

**Use this rule when**: Writing or reviewing any MATLAB code for standards compliance

### [live-script-generation.md](live-script-generation.md)
Guidelines for generating MATLAB Live Scripts in plain text `.m` format:
- Plain text Live Script formatting rules
- Section structure and documentation
- Mathematical notation and LaTeX support
- Visualization best practices
- Version control compatibility

**Use this rule when**: Creating MATLAB Live Scripts that need to be version-controlled or AI-generated

### [matlab-performance-optimization.md](matlab-performance-optimization.md)
Performance optimization guidelines for MATLAB development:
- Profiling and benchmarking techniques
- Vectorization and implicit expansion
- Memory management and pre-allocation
- Parallel computing with parfor and parfeval
- App Designer performance optimization
- JIT compiler optimization patterns
- File I/O performance strategies

**Use this rule when**: Writing performance-critical MATLAB code, optimizing existing code, or building responsive applications

## Quick Start

Choose your AI coding tool and follow the appropriate setup instructions:

### Cursor

**Option 1: Project Rules (Recommended)**

1. Create a `.cursor/rules` directory in your project
2. Copy the rule files you want to use:
   ```bash
   mkdir .cursor/rules
   cp matlab-coding-standards.md .cursor/rules/
   cp live-script-generation.md .cursor/rules/
   cp matlab-performance-optimization.md .cursor/rules/
   ```
3. Cursor will automatically load these rules for your project

**Option 2: Reference with @**

In your Cursor chat, reference rules directly:
```
@matlab-coding-standards.md Write a function to calculate eigenvalues
```

**Option 3: Global Rules**

Add to Cursor Settings > General > Rules for AI:
```
When writing MATLAB code, follow the standards at @matlab-coding-standards.md
```

### Windsurf

**Option 1: Workspace Rules**

1. Create a `.windsurf/rules` directory in your workspace
2. Copy the rule files:
   ```bash
   mkdir .windsurf/rules
   cp matlab-coding-standards.md .windsurf/rules/
   cp live-script-generation.md .windsurf/rules/
   cp matlab-performance-optimization.md .windsurf/rules/
   ```
3. Windsurf will automatically apply these rules to your workspace

**Option 2: Global Rules**

Add to your `global_rules.md`:
```markdown
# MATLAB Development

When working with MATLAB code:
1. Follow naming conventions: lowerCamelCase for functions, UpperCamelCase for classes
2. Use arguments blocks for input validation
3. Limit function inputs to 6 or fewer
4. Use spaces (4 per indent), not tabs
5. Keep lines <= 120 characters

For complete standards, reference: [path/to/matlab-coding-standards.md]
```

### Claude Code

**Option 1: Project CLAUDE.md (Recommended)**

Create a `CLAUDE.md` file in your project root:
```markdown
# MATLAB Project Rules

When working with MATLAB code in this project, import and follow these rules:

@matlab-coding-standards.md
@live-script-generation.md
@matlab-performance-optimization.md
```

**Option 2: Direct Reference**

In your conversation with Claude Code, use the @ symbol:
```
Please review this code for standards compliance @matlab-coding-standards.md

[paste your code]
```

**Option 3: User-Level Rules**

Add to `~/.claude/CLAUDE.md`:
```markdown
# MATLAB Development Rules

When I'm working with MATLAB code, always:
- Follow the standards in @matlab-coding-standards.md
- Use lowerCamelCase for functions and UpperCamelCase for classes
- Validate inputs using arguments blocks
- Keep code readable with proper spacing and comments
```

### GitHub Copilot

**Option 1: Repository Instructions**

Create `.github/copilot-instructions.md`:
```markdown
# MATLAB Coding Standards

This repository uses MATLAB. Follow these standards:

## Naming Conventions
- Functions: lowerCamelCase
- Classes: UpperCamelCase
- Variables: lowerCamelCase (descriptive names)
- Name-Value arguments: UpperCamelCase

## Code Style
- Indentation: 4 spaces (no tabs)
- Line length: <= 120 characters
- Use arguments blocks for input validation
- Limit functions to <= 6 input arguments
- Use " for strings (not ')

## Documentation
- H1 line immediately after function declaration
- Include help text with syntax, inputs, outputs
- Use %% for section dividers

For complete standards, see: matlab-coding-standards.md
```

**Option 2: Path-Scoped Instructions**

Cre

... (truncated)