> A wiki allows many users to work on the same stuff, that's something
> totally different. Help-comments in the source files would nullify 
> this approach. 

I've no real idea what a 'wiki' is. 

> However to generate an empty framework/skeleton it will 
> probably be necessary to use such a tool and to add a bare minimum of 
> help-commands to the sources.

And regenerate it every time a component has properties changed or 
added, that's several updates each year.  That's the benefit if putting 
the help text in the source and extracting it to an external help file, 
the properties, types and methods are always documented correctly, 
whereas documentation maintained separately is usually out of date 
before it's released. 

> I for instance hate to read source code with such included comments

I agree.  But I also hate wasting time trying to work out exactly how 
the ICS components work, which is why I try and add extended notes on 
any changes I make.  Writing it as help comments takes only a few more 
minutes.  I'd not bother to go off to try and update some 'wiki' system.
And given past documentation efforts, I doubt many others would either. 

Angus




-- 
To unsubscribe or change your settings for TWSocket mailing list
please goto http://www.elists.org/mailman/listinfo/twsocket
Visit our website at http://www.overbyte.be

Reply via email to