PDA

View Full Version : Describing a program I wrote in a report



superarthur
March 26th, 2010, 08:25 PM
I've written a small program for my science research project, and I need to write about it in my report.
Does anyone have any idea how to describe a program in a scientific report? Like how should I mention the modules/library used.

Many thanks in advance,
Arthur

gnometorule
March 27th, 2010, 09:07 PM
I've not personally used it, but I believe the standard freeware used to document your programs is

Doxygen.

You could download it and crank your program through it, and maybe that already does the trick. If not, reading up about it (I'm sure there's online documentation), probably gives you an idea how people communicate program structure.

superarthur
March 27th, 2010, 10:11 PM
From wikipedia:

Doxygen is a documentation generator (http://en.wikipedia.org/wiki/Documentation_generator) for C++ (http://en.wikipedia.org/wiki/C%2B%2B), C (http://en.wikipedia.org/wiki/C_%28programming_language%29), Java (http://en.wikipedia.org/wiki/Java_%28programming_language%29), Objective-C (http://en.wikipedia.org/wiki/Objective_C_programming_language), Python (http://en.wikipedia.org/wiki/Python_%28programming_language%29), IDL (http://en.wikipedia.org/wiki/Interface_description_language) (Corba (http://en.wikipedia.org/wiki/Corba) and Microsoft flavors), Fortran (http://en.wikipedia.org/wiki/Fortran), VHDL (http://en.wikipedia.org/wiki/VHDL), PHP (http://en.wikipedia.org/wiki/PHP), C# (http://en.wikipedia.org/wiki/C_Sharp_programming_language), and to some extent D (http://en.wikipedia.org/wiki/D_programming_language).
Unfortunately, I wrote my program in Perl...

myrtle1908
March 28th, 2010, 08:44 AM
From wikipedia:

Unfortunately, I wrote my program in Perl...

perlpod - the Plain Old Documentation format ... http://perldoc.perl.org/perlpod.html

slavik
March 28th, 2010, 09:04 AM
just say what your program does and how. the libraries that it uses are irrelevant.

derekeverett
March 28th, 2010, 09:12 AM
Maybe you could score a couple points by mentioning your own programs limits/short-comings? Or ideas you'd like to implement in future versions?