OpenEuphoria

Re: Standard Euphoria Library project

• Posted by Derek Parnell <ddparnell at bigpond.com> Jul 18, 2005
• 601 views

cklester wrote:
> 
> Gordon Webster wrote:
> > 
> > One question ... should we implement a really (really) simple
> > self-documenting
> > system?
> > 
> > -- Module: SimpleHashTables.e
> > -- Part of the Euphoria Standard Library
> > -- Contributed by Joe Coder, July 2005
> > --start-eudoc
> > -- SimpleHashTables.e
> > -- Hashtables of key/value pairs. Keys and values can be any Euphoria Object
> > -- Duplicate keys and the removal of duplicates are now also supported.
> > --end-eudoc
> 
> Without enclosed comments (like /* comments [newline] more comments */, this
> kind of documenting would be horribly inefficient. Having to manually manage
> all the line breaks? Imagine inserting or deleting text.  We need multi-line
> commenting before this would be viable.

Hmmm... not so sure about that. I've been using this style of documention in
Win32lib for years now and I've not had problems.
 
> Please note my paragraph is perfectly justified. :D

But is it justifiable? 

-- 
Derek Parnell
Melbourne, Australia
irc://irc.sorcery.net:9000/euphoria