Introduction
This page
describes the structure of source code development for the software used in my
research projects. The benefits of a structured file naming system cannot be understated
even for projects of modest size and complexity.
|
Source Code Naming Schema |
|
|
|||||
|
- |
- |
- |
- |
- |
- |
Reference Type (Description of reference) |
|
|
| |
- |
- |
- |
- |
- |
Context (Project, client, Date Started) |
|
|
| |
| |
- |
- |
- |
- |
Function (Description) |
|
|
| |
| |
| |
- |
- |
- |
Target device (Description) |
|
|
| |
| |
| |
| |
- |
- |
Version/Status (Description, Last Updated) |
|
|
| |
| |
| |
| |
| |
- |
File Extension (Description) |
|
|
↓ |
↓ |
↓ |
↓ |
↓ |
↓ |
|
|
|
|
|
|
|
|
|
|
|
|
Source Code Naming Lookup |
|
|
|||||
|
Reference types |
|
|
|||||
|
|
|
|
|
|
|
|
|
|
F |
xx |
xx |
xx |
xx |
xxx |
Function |
|
|
H |
xx |
xx |
xx |
xx |
xxx |
Header |
|
|
L |
xx |
xx |
xx |
xx |
xxx |
Lookup information (for programming reference only) |
|
|
M |
xx |
xx |
xx |
xx |
xxx |
Master processor |
|
|
|
|
|
|
|
|
|
|
|
Contexts |
|
|
|||||
|
|
|
|
|
|
|
|
|
|
x |
31 |
xx |
xx |
xx |
.xxx |
EngD_VIVE_2005_ |
|
|
|
|
|
|
|
|
|
|
|
Functions |
|
|
|||||
|
|
|
|
|
|
|
|
|
|
x |
xx |
01 |
xx |
xx |
.xxx |
BIOS |
|
|
x |
xx |
99 |
xx |
xx |
.xxx |
Template |
|
|
|
|
|
|
|
|
|
|
|
Target Devices |
|
|
|||||
|
|
|
|
|
|
|
|
|
|
x |
xx |
xx |
18 |
xx |
.xxx |
MicroChip PIC 18F4620 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
File Extensions |
|
|
|||||
|
|
|
|
|
|
|
|
|
|
x |
xx |
xx |
xx |
xx |
.bas |
Basic Source Code (see note 1) |
|
|
x |
xx |
xx |
xx |
xx |
.ftl |
MicroChip Fuzzy Technology Language |
|
|
x |
xx |
xx |
xx |
xx |
.inc |
Include file |
|
|
x |
xx |
xx |
xx |
xx |
.m |
MatLab m-file |
|
|
|
|
|
|
|
|
|
|
|
Source Code Library |
Download File |
Status |
|||||
|
|
|
|
|||||