> Devon,
>
> > From: Devon McCormick
> >
> > Having the special "NB.*" definition line is also good
> because,
> once a
>
> The actual convention is
> NB.*verbname v description
> or
> NB.*adverbname a description
> etc.
>
> It was designed for scriptdoc tool.
>
> There is also a feature in j wd environment which calls
> scriptdoc
> if you hit Ctrl+F1 when your caret is on top of a verb
> name.
> Unfortunately it works only for verbs in z (and j and
> jhelp) locale.
>
> In http://www.jsoftware.com/jwiki/AndrewNikitin/jhelp
> I documented how to hack help-invoking code to include
> verbs in base
> locale.
>
> It is worth noting here that Oleg has made a few attempts
> to improve
> on scriptdoc (htmldoc comes to mind first). However,
> neither
> scriptdoc, nor its alternatives seem not to be widely known
> and used,
> which is shame.
I document code in the following manner:
mymonad =: 3 :0 "1
NB. the documentations goes
NB. here
y + y NB. and here, if needed
)
For me, to have documentation inside parts of speech is handy, so I can
type
mymonad
in the console and read the docs associated with it.
Haven't heard about conventions regarding this. Where can I read about them?
Alexander
----------------------------------------------------------------------
For information about J forums see http://www.jsoftware.com/forums.htm
