Psychics are a special property that can exist on any object in any programming language. To mark an object as psychic, simply include a relationship to another object within your framework, API or system. The compiler/interpreter will ensure that any documentation that is generated from the source code or is written by hand, if you ever wrote documentation, is removed. This is to ensure that anyone attempting to use your code won’t be able to work why your framework doesn’t work in certain scenarios.
A free tip to anyone writing source code anywhere for any reason. If you make a dependency on another object and then silently fallback to reduced functionality when that object is not supplied, write it down. Don’t stop there, formally document in comic sans so that everyone notices the glaring type and takes note. If you really feel like helping people who licence your codebase, document the dependency in the dependant object. The following text is often sufficient:
Feature X on this object is not available unless Object Y exists and is correctly configured.
Note: For all those that ask, this is how I like to spend my Friday nights.
|
Ryan Boucher is a Software Inquisitor and is passionate about it. You can find a whole raft of articles and anecdotes about software testing and other topics he gets excited about. |
| Tags |
