Skip to content

Some naming conventions

Phil Garner edited this page Aug 3, 2013 · 2 revisions

In writing ISS I tried to stick to these conventions. Of course, much of it is subjective.

File names in bin/ should be lower case with words separated by hyphens, as in /usr/bin etc.

flat-start.sh 	(not flatStart.sh)
dict-man.rb	(not dictMan.rb)

Favour standard file extensions rather than htk-specific ones

mmf.txt	(not model.mmf)
train-mlf.txt	(not train.mlf)

Shell variable names should not contain hyphens or underscores

dbaseRoot     	  (not dbase_root)
mainMLF	  (not main_MLF)

Environment variables should be upper case and underscore separated

DBASE_ROOT
MAIN_MLF

Keep lines to a maximum of 80 characters. Use a basic indent of 4 spaces. Avoid really short abbreviations where possible

train		(not TRN)
devel		(not DEV)

Avoid brackets around shell variables where possible

$mainDir      (not ${mainDir})

Use $(cmd) instead of `cmd` Use ksh style [[ ]] instead of sh style [ ]

Favour create over build, make, gen etc.

Clone this wiki locally