|
One can increase documentation be lengthening the names used in GAMS code. In particular
| • | GAMS allows 63 character long names and 255 characters of explanatory text defining each of the following items: sets, parameters, variables, scalars, acronyms, equations, models and files. |
I feel users should exploit this and use descriptive 63 character names.
X is a wonderful name in theory, yet lousy in practice, as is A(i,j).
Type a little more and reap the rewards in being able to figure out models later. More typing always helps and it is just not that hard.
More than half the models in the GAMS model library have such failings.
| • | Let no item go undefined. Enter explanatory text or comments containing units, sources and descriptions. |
| • | Check for completeness in the symbol listing with $Onsymlist making sure all names are somewhat apparent and all items have explanatory text as illustrated in the Standard Output chapter. |
| • | Associate text with set element definitions and use the up to 63 character set element name capability. (Note that names longer that 10 characters do not work well in multi column displays.) |
Remember only You can cause your GAMS code to be self documenting.
|