dokumentation för bash

Här pratar vi programmering i dessa olika former. Perl, C/C++, Pascal, ADA, Lisp, COBOL, ZX Basic och mm.
Post Reply
ErikW
Posts: 82
Joined: 13 June 2003, 21:38

dokumentation för bash

Post by ErikW » 11 July 2007, 20:42

Hej,
Jag vill dokumentera funktioner i bash. I c++ finns tex doxygen, i java javadoc. Vad kan/brukar användas i bash?

PJ

Post by PJ » 12 July 2007, 07:28

Jag har då aldrig sett något sådant för bash, finns det?
Tills du eller någon annan hittar en sådan dokumentation kan du läsa: Advanced Bash-Scripting Guide, den täcker upp de mesta som man kan behöva när man skriver bash-script.

Finns en hel del annat intressant på The Linux Documentation Project

ErikW
Posts: 82
Joined: 13 June 2003, 21:38

Post by ErikW » 12 July 2007, 09:02

Just det, jag kan inte heller minnas att jag sett något. Man skulle kunna göra en fuling och använda doxygen med lite preprocessing. Det ska tydligen gå med python+doxygen. Man lär dock bara få en subset av all funktionalitet, men det räcker nog för mig.

Dina länkar har jag, de är utomordentliga, rekommenderas till övriga!

PJ

Post by PJ » 12 July 2007, 10:18

Testade att söka på bashdoc och hittade följande länk:
http://dufflebunk.homeip.net/~dufflebunk/sorcerer/docs/

Verkar som om någon har påbörjat ett sådant försök med javadoc som modell.

ErikW
Posts: 82
Joined: 13 June 2003, 21:38

Post by ErikW » 12 July 2007, 11:05

det var en intressant länk, dock är den väldigt simpel

Troligen kommer vi dock att skriva c++-kommentarer ovanför varje funktion (med # framför).

Ex.

#///! description
#/// bla bla
#/// bla bla
dut_set_wep_encryption()
{
iwconfig .....

}

Sedan kopierar vi filerna till ett temporärt bibliotek, kör en sed och tar bort # framför #/// (sed s@#///@///@g)
Då är det klart att genereras dokumentation.

Post Reply