On Wed, Mar 22, 2000 at 12:44:11PM +0000, Keith Wansbrough wrote:
> There seems to be some agreement at least that a clean and unintrusive
> syntax like POD or the ISE Eiffel stuff is preferable to something as
> noisy as XML; it certainly seems to me that it would be much more
> rapidly adopted.
A simple approach might ask authors to do the following:
1. Use Haskell's literate comment convention (either one).
2. Give explicit type signatures for all exported functions.
3. Place comments before the things they describe. In particular, module
overview at the start of the file, interface comments before type
signatures.
That's not much, but a program could then extract the interface without
knowing a lot of Haskell.
Extra structure for these comments could be worked out later.
