Positional cues or not
John Meacham
john@foo.net
Mon, 12 Feb 2001 03:19:43 -0800
On Mon, Feb 12, 2001 at 03:04:01AM -0800, Simon Marlow wrote:
> To be clear, I'm not arguing *against* positional cues, I'm arguing
> *for* using a distinctive comment style for documentation comments.
yes. Another reason to use a distinctive document style is that comments
are often used to do things like block out unwanted code, or comment out
blocks which are not needed in hugs say but are in ghc (under the
presumption someone will go in and edit it later). it would be bad if
spurious documentation were produced. also this would make documented
haskell more backwards compatable with non-documented haskell since it
wont pick up any pre-existing comments until you change them to the
haskelldoc style whatever that may be.
John
--
--------------------------------------------------------------
John Meacham http://www.ugcs.caltech.edu/~john/
California Institute of Technology, Alum. john@foo.net
--------------------------------------------------------------