And how is someone reading the script to know what function is defined where?
Pod.
Red flag. You are asking for synchronization of documentation and code, and then further asking for everyone to always keep in mind all of the relevant documentation whenever they produce more code.
If this was an effective solution, then good programmers wouldn't mind lots of global variables and lots of tightly coupled functions. After all, if you can keep track of everything, you can always come up with shorter answers that way.
For more thoughts on why verbose documentation is not a good resolution to programming problems, see the discussion starting at Re (tilly) 2 (disagree): Another commenting question,.
| [reply] |