=========================================
Script Marking Code comment abbreviations
=========================================
-Ian! D. Allen idallen@idallen.ca

I use these abbreviations when marking your shell scripts:

$0   - missing command name in error message
alg  - algorithm not explained - how are you doing this?
args - incorrect arguments should be echoed back to user in error messages
bc   - block comment is missing, wrong, incomplete, obvious, or unhelpful
dup  - duplicated or unnecessary code
com  - comments are missing or incorrect
exif - unnecessary use of "else/elif" after IF clause ending in "exit"
fmt  - formatting error - line too long, line wrap, poor layout
ind  - poor, missing, or incorrect use of indentation (see book)
mis  - missing code or comment required by specification
mol  - missing or incorrect one-line description comment in header
msg  - error or warning message is missing
msx  - missing or incorrect Syntax comment in header
nca  - no "cat" needed; superfluous use of "cat" command (not necessary)
ncs  - no command substitution $(...) needed; use command directly
ner  - not an error - output should go to standard output, not stderr (unit 2)
nex  - no exit - script is missing an exit statement here
nfx  - do not exit your main program from inside a function
nglob - do not use or set global variables in functions
nlet - don't use "let" to receive string arguments
nnc  - not necessary (probably correct; but, should be left out)
nop  - not optional; this argument is not optional; use "arg" not "[arg]"
noi  - don't declare variables as integer - it disables error checking
obv  - obvious comments; comments add nothing to what is already in the code
opt  - arguments are optional (you prompt if missing) use "[arg]" not "arg"
out  - output format does not match assignment specification
pco  - missing, incomplete, or incorrect Purpose comment in header
port - non-portable syntax does not work on some versions of Unix
pui  - poor (unhelpful or annoying) User Interface message (e.g. "too many")
quo  - quoting is incorrect (including missing quotes)
ser  - missing use of standard error for prompt or error message
sim  - simplify; code is too complex
sp   - spelling or grammar error
strt - string test used to compare integers (use -eq for integers)
syn  - syntax is incorrect (see the man page)
unk  - unknown purpose (code, comment, or syntax)


If you don't understand why I made the comment, see me.

"Less code is better code"