in reply to Re: Shell/perl Documentation
in thread Shell/perl Documentation

I just have bash, ksh and perl scripts that I need to document. The documentation needs to be relatively simple explaining what the script does.

As far as performance goes, would it be a good idea to keep the documentation separate? These are existing working scripts. Separating the documentation could be safer.

Replies are listed 'Best First'.
Re^3: Shell/perl Documentation
by thargas (Deacon) on Jul 08, 2013 at 12:24 UTC
    You say "Separating the documentation could be safer". I've found that keeping the documentation in the same file as the code make it more likely that it will be updated when the code changes; you don't have to find the doc file. Personally, I'd say that it's safer to have up-to-date docs.
[reply]

In Section Seekers of Perl Wisdom