begin quoting David Brown as of Sun, Mar 16, 2008 at 10:15:29PM -0700: > On Sun, Mar 16, 2008 at 10:05:10PM -0700, SJS wrote: > > >>I don't think it is possible to write meaningful documentation for > >>non-trivial and non-redundant code before the code has been written. We > >>like to maintain an illusion that things can work this way, but they > >>don't. > > > >Oh, I dunno. The less trivial and redundant the code, the easier it > >is to write documentation for. > > > >Trivial code is hard to write meaningful documentation for. > > The distinction I'm trying to make is writing the documentation before > writing the code. Non trivial code is usually not well defined until it is > being written or has been written. Thinking otherwise is mostly an > illusion.
Sounds like you're trying to write *what* something does, instead of *why*. -- I agree, writing the what before it is there is very difficult. Stewart Stremler -- [email protected] http://www.kernel-panic.org/cgi-bin/mailman/listinfo/kplug-lpsg
