Dyalog 2008


Kai Jaeger

APL Team Ltd

Types Of Documentation

The Big Picture

Whatever is appropriate

The Reference

A reference can be made by using all sorts of technology:

Problems 1

Distance: The farer away the doc is, the more likely it is not updated in case of enhancement/changes

Debugging: Nobody is going to debug the documentation - nobody!

Problems 2

What is worse? A documentation that is...





With OO, many pieces of information can be extracted from the class definition