On 24 Oct 2008, at 20:06 , Rob Hamerling wrote:
> With the added comments I think the adc_hardware lib can be published
> (my vote is now: 1).
>
> I do not agree with your view about the function of samples.
>
> A *learning* sample shows on purpose one *simple* of probably many
> possibilities of a library. It is meant to get a new user started.
That is what the sample should do, IMHO. Maybe it should be called
"start_tcc77.jal"
> But
> after a first tryout users always want to do more complex things than
> the sample shows! But how?
I agree that there should be a program that uses every procedure in
the lib, to document its use.
Maybe not now, but certainly later. It should be written by the
author or adapter of the library.
> Some doc (either separate or as comment in the library) should inform
> the user about everything the library can do. It should explain the
> functionality of each procedure, the meaning and possible/allowed
> values
> of the various external constants and variables, and the limitations.
> Providing the complete information ('reference manual') allows him to
> *learn* all by himself how to explore the possibilities of the library
> for his specific needs.
An actual program is always better than any documentation. I've seen
countless "examples" of code THAT DO NOT COMPILE. We should never do
this.
>
> Anyway, that's the way I would like it.
>
> Regards, Rob.
>
>
>
> --
> Rob Hamerling, Vianen, NL (http://www.robh.nl/)
>
> >
---
ir EE van Andel [EMAIL PROTECTED] http://www.fiwihex.nl
Fiwihex B.V. Wierdensestraat 74, NL7604BK Almelo, Netherlands
tel+31-546-491106 fax+31-546-491107
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"jallib" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/jallib?hl=en
-~----------~----~----~----~------~----~------~--~---
