Declaration Standards¶
Purpose: Consistent coding standards across AudioLab
Overview¶
This directory defines how to write AudioLab code: naming, organization, declarations, and cross-platform considerations.
Files¶
- naming_conventions.md - How to name types, functions, variables, files
- header_organization.md - Include order, what goes in headers
- forward_declarations.md - When/how to forward declare
- api_export_macros.md - DLL export/import for Windows/Linux/macOS
Quick Reference¶
Naming¶
- Classes:
PascalCase - Interfaces:
IPascalCase - Functions:
snake_case - Members:
snake_case_ - Constants:
UPPER_SNAKE_CASE - Files:
snake_case.hpp
Header Includes¶
- Own header
- C stdlib
- C++ stdlib
- Third-party
- AudioLab
- Local
Forward Declarations¶
- Pointer/reference: Forward declare
- Value/inheritance: Full include
Exports¶
- Public API:
AUDIOLAB_API - Internal: No macro
Consistency is key. Follow these standards throughout the codebase.