The following tips are adapted from the KDF Programming Style Guide and are standard practice for all projects under Imperial contract.
A properly written var'aq program represents a series of operators delineated as mIw [procedures or logical steps in a process]. wa'pe'ghom [single-scratch; one-line programs] are not acceptable unless the program reflects a single mIw.
All code must be commented to identify the author and describe the code.
Any function that returns a binary value must be named with the -'a' suffix.
For security reasons, I/O operations must be done using high-level operators. tlholghun [bare-metal programming] is acceptable only if no high-level virtual device support exists.
All functions in a user-defined package must be identified with the package name.
A function does one thing and one thing only. Functions that take operation selector parameters are unacceptable.
By the same token, enforce strict modularity. No SoDmIw [flood-procedure; side effects] other than user communication!
All programs must accomplish their tasks or fail gracefully. Crashing is not an option in a completed project.
SopHochjangwI' [eat-all-function; polymorphic functions] are acceptable, but must behave sanely if they cannot understand the input.
If it is not documented, it is not there. Do not rely on private functions or SoDmIw.
Named values serve one of four purposes: constants, parameters, indexes, and program globals. Local variables are sloppy and therefore unacceptable.
