[Mono-list] ECMA compliance
Miguel de Icaza
miguel@ximian.com
23 Nov 2001 17:17:26 -0500
> But I mean using already extracted documentation.
> That is, what's the difference between:
> a) Always extracting Master File (en-US) from sources before using it;
> and
> b) Maintaining it manually as a separate file;
Those are not too different, but I was thinking a few minutes ago that
there is a problem with putting the documentation together with the
source code.
> Also, I'm worried about people who will read the *sources*,
> they will need the comments, right?
This is the reason I am no longer so excited about keeping the
documentation in the sources. The documentation in the sources might be
extensive, and might contain examples of the *external* API.
But when you are reading or maintaining the code you are more interested
in the implementation details. The implementation details are going to
be lost in the noise I think.
Anyways, something to keep in mind.
Miguel.