Omien ohjelmien help-sivu

[Snufkin]

Moi!

Onko jossain ohjeita, miten tehdään oikeaoppisesti omaan komentoriviohjelmaan --help -toiminto? Onko tuo help vain tekstiä, minkä ohjelma tulostaa --help/h -argumentilla? Vai onko tapana tehdä oma tiedosto tms.?

Entä onko jossain listaus argumenteista, mitä kannattaa käyttää, jotta olisi yhteneväinen muun komentotulkin käytön kanssa?

[Tomin]

Millä kielellä olet kirjoittamassa ohjelmaa? Onko käytössä jo joku parseri noille argumenteille? Yleensä sellaista käytettäessä ohjevipu lisätään automaatisesti tai ainakin sille on vakiintunut käytäntö.

Esimerkkejä parsereista Pythonista ja Rustista. Nuo lisäävät ohjeen automaattisesti. C-kielellä voi käyttää getoptia, jolla se parsittaisiin ihan kuten muutkin argumentit, mutta arvon asettamisen sijaan tulostetaan ohje ja poistutaan.

Yleisiä ohjeita argumenteista löytyy vaikkapa täältä: https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
Ja jossain olen nähnyt myös listan tyypillisistä merkityksistä kirjaimille. Laitan tähän, jos löydän sen.

[Snufkin]

Millä kielellä olet kirjoittamassa ohjelmaa? Onko käytössä jo joku parseri noille argumenteille? Yleensä sellaista käytettäessä ohjevipu lisätään automaatisesti tai ainakin sille on vakiintunut käytäntö.

Varmaan englanniksi, kun tässä on samalla hieman alan opiskelua mukana. Suomen kieli ei liene kovin laajassa käytössä. Jostain syystä tämä dokumentaatiopuoli loistaa poissaolollaan lähes kaikilla ohjelmointikursseilla.  Ainoastaan Docstring on ollut jollain kurssilla.

Nuo parserit mulle ihan uutta. Varmaan juuri tuota hain, mutta pitää hieman perehtyä noihin.

[Tomin]

Varmaan englanniksi, kun tässä on samalla hieman alan opiskelua mukana. Suomen kieli ei liene kovin laajassa käytössä.

Tarkoitin ohjelmointikieltä. Eri kielille on omat kirjastonsa tähän tarkoitukseen.

[Snufkin]

Varmaan englanniksi, kun tässä on samalla hieman alan opiskelua mukana. Suomen kieli ei liene kovin laajassa käytössä.

Tarkoitin ohjelmointikieltä. Eri kielille on omat kirjastonsa tähän tarkoitukseen.

C ja Python nyt opiskelussa. Varmaan C:llä teen aluksi noita komentoriviohjelmia. C++ -perusteet kanssa jo jotenkin hallussa.

Nuo laittamasi ovat hyviä linkkejä, kiitos. Perehdyn niihin.

[nm]

Pythonissa argparse kuuluu perusmoduuleihin, joten sitä voi käyttää aina suoraan. Suosittelisin kuitenkin Typer-kirjastoa, etenkin jos kirjoitat muutenkin tyypitettyä koodia. Sillä saa rakenneltua pienellä vaivalla hyviä komentorivityökaluja. Rich kannattaa ottaa myös mukaan kuvioihin, jos haluat esittää listoja tai taulukoita tai muuten kauniisti aseteltua tekstiä komentorivisovelluksen ulostulona.