-
Notifications
You must be signed in to change notification settings - Fork 0
Naming Conventions
John Clardy edited this page Jul 28, 2026
·
3 revisions
- Use camelCase within each section of a file name and for variable names.
- Use PascalCase for folder names.
- Separate sections with an underscore (
_). - DO NOT use spaces in folder or file names.
- Capital letters are allowed, but DO NOT use all caps.
- Keep names short, descriptive, and consistent.
- Avoid special characters such as
@,#,$,%,&,*,(,), etc. - Use only letters, numbers, underscores (
_), and periods (.) where appropriate. - Microsoft Suite Files will be kept on SharePoint.
- Folder names should clearly describe their contents and follow a logical hierarchy.
- Use PascalCase for folder names.
- DO NOT use spaces in folder names.
GasTurbine / CompressorAnalysis
- Document names must use camelCase for each section, separated by underscores.
- Use meaningful, searchable descriptions.*
component_description
hpc_firstStagePerformance.docx
lpc_efficiencySummary.xlsx
gasTurbine_performanceReport.pdf
- Use camelCase for all variable names.
- Variable names should clearly describe their purpose.
- Avoid abbreviations unless they are widely understood (e.g.,
rpm,temp,id). - Do not use spaces or special characters.
- Avoid single-letter variable names except for short loop indices.
massFlowRate
compressorEfficiency
inletTemperature
pressureRatio
stageCount
x
temp1
COMPRESSOR_TEMP
pressure-ratio
mass flow
| Item | Convention | Example |
|---|---|---|
| Folder | PascalCase / PascalCase |
GasTurbine / CompressorAnalysis |
| Document | camelCase_camelCase |
hpc_firstStagePerformance.docx |
| Variable | camelCase |
compressorEfficiency |