Comments on: The joys of Literate Programming http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/ Software development wisdom and common-sense for the scientist-programmer Mon, 14 Nov 2011 14:47:31 +0000 hourly 1 http://wordpress.org/?v=3.0.4 By: Daniel http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/comment-page-1/#comment-357 Daniel Tue, 18 Aug 2009 20:40:15 +0000 http://www.programming4scientists.com/?p=416#comment-357 I think you should expand the section on the tools to extract documentation. Using such tools is helpful even if you are the only programmer... I use NaturalDocs (http://www.naturaldocs.org/) in my projects, and it works like a charm, even with bash scripts :-) Since NaturalDocs does not require a strict Syntax to be followed, it comes natural (nomen est omen). Here is an example: # Function: abs # # Calculate the absolute value of a number # # Parameters: # num - a real number Thanks a lot for the good texts - I can really relate to much of it! Cheers, Daniel I think you should expand the section on the tools to extract documentation. Using such tools is helpful even if you are the only programmer…

I use NaturalDocs (http://www.naturaldocs.org/) in my projects, and it works like a charm, even with bash scripts :-)

Since NaturalDocs does not require a strict Syntax to be followed, it comes natural (nomen est omen).

Here is an example:

# Function: abs
#
# Calculate the absolute value of a number
#
# Parameters:
# num – a real number

Thanks a lot for the good texts – I can really relate to much of it!

Cheers,
Daniel

]]> By: Rich http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/comment-page-1/#comment-292 Rich Fri, 03 Apr 2009 18:28:26 +0000 http://www.programming4scientists.com/?p=416#comment-292 Wow - that's....an amazing approach to coding! Thanks for sharing that example, DeRien. Wow – that’s….an amazing approach to coding! Thanks for sharing that example, DeRien.

]]> By: DeRien http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/comment-page-1/#comment-291 DeRien Fri, 03 Apr 2009 14:19:31 +0000 http://www.programming4scientists.com/?p=416#comment-291 When i was in college, i worked as a counselor to students in an introductory programming class. My favorite (worst) program looked like this (really): two = 1; three = 4; four = 17; ... seven = three + four; Needless to say, the code was completely uninterpretable. Friends pointed out that the writer wouldn't ever run out of variable names. When i was in college, i worked as a counselor to students in an introductory programming class. My favorite (worst) program looked like this (really):

two = 1;
three = 4;
four = 17;
…
seven = three + four;

Needless to say, the code was completely uninterpretable. Friends pointed out that the writer wouldn’t ever run out of variable names.

]]> By: links for 2009-01-29 « pabloidz http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/comment-page-1/#comment-154 links for 2009-01-29 « pabloidz Thu, 29 Jan 2009 12:02:03 +0000 http://www.programming4scientists.com/?p=416#comment-154 [...] The joys of Literate Programming Programming for Scientists (tags: programming) [...] [...] The joys of Literate Programming Programming for Scientists (tags: programming) [...]

]]> By: it, it...: Dirty scripting http://www.programming4scientists.com/2009/01/26/the-joys-of-literate-programming/comment-page-1/#comment-153 it, it...: Dirty scripting Tue, 27 Jan 2009 16:17:26 +0000 http://www.programming4scientists.com/?p=416#comment-153 [...] http://www.programming4scientists.com/2009/01/the-joys-of-literate-programming/ just an interesting article. And other one http://www.codinghorror.com/blog/archives/001216.html [...] [...] http://www.programming4scientists.com/2009/01/the-joys-of-literate-programming/ just an interesting article. And other one http://www.codinghorror.com/blog/archives/001216.html [...]

]]>