|There's more than one way to do things|
Standardising code documentationby Win (Novice)
|on May 02, 2006 at 14:36 UTC ( #546904=perlquestion: print w/replies, xml )||Need Help??|
Win has asked for the wisdom of the Perl Monks concerning the following question:
I am in the process of writing documentation for some of my code. I am trying to standardise the documentation as much as possible so that similar points are included in each program. One of the lists that I want to standardise is the ‘motivation for creating a distinct program in a process that uses a cluster of Perl programs’. I believe that many code documenters could use this list. To achieve this I will need comment from others. The motivations that I was thinking of including are:
a) To ease viewing of code.
b) To allow multiple process paths to be run at once.
c) To create a distinct process for which the code is frequently updated.
d) To create a distinct process for which the code is infrequently updated.
e) To create conditions to be placed on the system call eg. CPU usage.
f) To break code so processes can be retrieved from multiple directory locations or physical drives.
g) To make use of differential file access privileges.
There may be many reasons for breaking up a single piece of code of course. Can people think of other reasons? Also, is this exercise worthwhile?
Back to Seekers of Perl Wisdom