LinuxQuestions.org
Share your knowledge at the LQ Wiki.
Go Back   LinuxQuestions.org > Forums > Linux Forums > Linux - Newbie
User Name
Password
Linux - Newbie This Linux forum is for members that are new to Linux.
Just starting out and have a question? If it is not in the man pages or the how-to's this is the place!

Notices

Reply
 
Search this Thread
Old 06-02-2009, 11:56 AM   #1
senthilmuthiah
Member
 
Registered: Mar 2009
Distribution: Ubuntu, Fedora
Posts: 56

Rep: Reputation: 16
Question Shell Scripting & Documentation


Hi All:

I was wondering whether there is anything similar to javadoc in Shell scripts also. 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!
 
Old 06-02-2009, 01:02 PM   #2
David the H.
Bash Guru
 
Registered: Jun 2004
Location: Osaka, Japan
Distribution: Debian sid + kde 3.5 & 4.4
Posts: 6,823

Rep: Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946Reputation: 1946
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.
 
  


Reply

Tags
documentation, linux, script, shell


Thread Tools Search this Thread
Search this Thread:

Advanced Search

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is Off
HTML code is Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Shell Scripting : compare two files & append rohits1991 Linux - Newbie 11 05-28-2009 01:11 AM
Shell scripting problems for md5sum & stat for filenames with spaces and $s QuietLeni Programming 3 03-19-2009 05:38 AM
Shell scripting: Print output to logfile, error to logfile & screen stefanlasiewski Programming 18 05-22-2008 12:47 PM
Shell scripting & piping dimavo Programming 8 04-24-2003 05:27 PM
bash shell scripting - && and || gui10 Programming 10 12-15-2001 03:37 PM


All times are GMT -5. The time now is 06:20 AM.

Main Menu
My LQ
Write for LQ
LinuxQuestions.org is looking for people interested in writing Editorials, Articles, Reviews, and more. If you'd like to contribute content, let us know.
Main Menu
Syndicate
RSS1  Latest Threads
RSS1  LQ News
Twitter: @linuxquestions
identi.ca: @linuxquestions
Facebook: linuxquestions Google+: linuxquestions
Open Source Consulting | Domain Registration