LinuxQuestions.org

LinuxQuestions.org (/questions/)
-   Linux - Newbie (http://www.linuxquestions.org/questions/linux-newbie-8/)
-   -   Shell Scripting & Documentation (http://www.linuxquestions.org/questions/linux-newbie-8/shell-scripting-and-documentation-730184/)

senthilmuthiah 06-02-2009 12:56 PM

Shell Scripting & Documentation
 
Hi All:

I was wondering whether there is anything similar to javadoc in Shell scripts also. :confused: I mean, just commenting using some keywords and then 'publish to html' or something of that sort, to get the documentation of the script.

Thanks for your time!

David the H. 06-02-2009 02:02 PM

I've never heard of any formal system like that. Shell scripting isn't generally as complex as using a full programming language, as it's mostly just a way to string together various other programs in a useful way. Since most shell scripts are created as quick-and-dirty ways to solve an immediate need, there's generally not much call for a complex documentation system. Script "documentation" is usually just whatever output you want to echo to standard out, or add as comments inside the script itself.

OTOH, a quick search of apt turned up robodoc, which says it can be used with shell scripts. Perhaps that's the kind of thing you're looking for.


All times are GMT -5. The time now is 03:40 PM.