Code meeting
Organization
Functions
- ‘Clean code’ * has help file — lists all inputs and outputs with descriptors
- functions have small number of mandatory inputs (typically 1-4)
- additional inputs are passed as ‘Flag’,value pairs. (see examples)
- long code is written in demarcated code blocks * As general a structure as possible
- (shouldn’t be hard-coded based on the unique configuration of a single microscope setup)
- computer independent (no hard coded directories)
- Folder is organized into subfolders by function
GUIs
- ready to launch and run
- ‘Clean code’ (see above)
- computer independent – no hard-coded paths.
- multi-platform ready — use system() commands instead of dos, use filesep instead of / ,
Beta
- GUIs and Functions that do not meet above criteria for clean/independent
- May be nearly finalized code that just needs help-file polished
- May be completely experimental or in development
- Organized into subfolders with readme describing function/GUI Goals as well as progress
This entry was posted in
General STORM and tagged
coding. Bookmark the
permalink.