A lot of times it helps to document the purpose of a definition and its arguments as this makes it easier to locate months or years later. And such information usually doesn't change that much when debugging.
2010/5/15 Björn Helgason <[email protected]> > A very short verb a well defined utility may not need much documentation. > A complex line may be difficult to explain and be much longer than the > code. > A system constantly being changed during development can easily get > outdated doc. > Documenting is unfortunately often left until later and later never > arrives. > > 2010/5/15 Andrew Nikitin <[email protected]>: > > > >> Haven't heard about conventions regarding > >> this. Where can I read about them? > > For example, in > > system\extras\help\user\scriptdoc.htm > > This is really old feature, at least 12 years > > old. The fact that it is not widely known or > > used must be a reflection of its virtues. > > Not even every standard library verb is > > documented that way. > > I do not quite understand why it is in such disuse. > > Apparently the need for quick online help for > > user-defined verbs and packages of verbs in J user > > community is not as great as I imagined. > > _________________________________________________________________ > > The New Busy is not the too busy. Combine all your e-mail accounts with > Hotmail. > > > http://www.windowslive.com/campaign/thenewbusy?tile=multiaccount&ocid=PID28326::T:WLMTAGL:ON:WL:en-US:WM_HMP:042010_4 > > ---------------------------------------------------------------------- > > For information about J forums see http://www.jsoftware.com/forums.htm > > > > > > -- > Björn Helgason, Verkfræðingur > Fornustekkum II > 781 Hornafirði, > t-póst: [email protected] > gsm: +3546985532 > sími: +3544781286 > http://groups.google.com/group/J-Programming > > > Tæknikunnátta höndlar hið flókna, sköpunargáfa er meistari einfaldleikans > > góður kennari getur stigið á tær án þess að glansinn fari af skónum > /|_ .-----------------------------------. > ,' .\ / | Með léttri lund verður | > ,--' _,' | Dagurinn í dag | > / / | Enn betri en gærdagurinn | > ( -. | `-----------------------------------' > | ) | (\_ _/) > (`-. '--.) (='.'=) ♖♘♗♕♔♙ > `. )----' (")_(") ☃☠ > ---------------------------------------------------------------------- > For information about J forums see http://www.jsoftware.com/forums.htm > ---------------------------------------------------------------------- For information about J forums see http://www.jsoftware.com/forums.htm
