Ispirati alle parti interne della piattaforma di destinazione

Dai un'occhiata al codice sorgente di BSD. Ad esempio, qui ci sono:

• usage(void) per lo strumento /usr/bin/uname di NetBSD [ fonte ]:

  usage(void)
  {
      fprintf(stderr, "usage: uname [-amnprsv]\n");
      exit(EXIT_FAILURE);
  }
  

• usage(void) per /usr/bin/telnet di NetBSD [ fonte ]

• usage(void) per /bin/ls di OpenBSD [ fonte ]

Dai un'occhiata alle alternative

E decidi tu stesso se stanno meglio o peggio. Puoi utilizzare Google CodeSearch per trovare altri, come:

• Uso di SkyLoad [ fonte ]

Come potete vedere, uno stile diverso tra questi e gli strumenti integrati dei sistemi BSD elencati sopra. Ciò non significa che devi seguire l'uno o l'altro. Ma di solito è bene guardarsi intorno e accontentarsi della soluzione coerente.

Una soluzione non standard per le 50 linee di aiuto ...

Se non ti piace evitare 50 righe di testo, puoi semplicemente leggere l'aiuto da un file di testo (in testo normale, o magari analizzare direttamente l'origine di man se ne hai creato uno). Trovo che sia un modo piuttosto elegante (come si può anche consultare il documento di testo), tuttavia per i programmi di sistema di base che li renderebbe intrinsecamente insicuri e introdurrebbero un punto di errore. Altre persone sostengono che è pesante per un messaggio usage o help , ma non è come se fossero chiamati in loop rapidi e stretti ...

In caso di dubbio, segui i giganti.

Uso stdout , perché un aiuto non è un errore.

Se questo è un lungo aiuto in C, provo a imitare here-docs:

printf("This is the help for MyWonderfulApp\n"
       "Options are:\n"
       "    --help: display what you are reading now\n"
       "    --quiet: output nothing\n");

Ma la maggior parte delle volte scrivo una pagina man usando i tag dedicati nroff -man . La guida in-app consiste semplicemente nel riferirsi a quella pagina man .

Se fossi in te, avrei semplicemente aperto fonti di grep , tail , cat , your_other_favorite_unix_shell_command per vedere come è fatto lì. Sono abbastanza sicuro che le loro modalità siano ben pensate e possano essere mantenute da molte persone.

Informazioni su stderr o stdout . È davvero semplice, se c'è un errore: scrivi a stderr , se è solo info - stdout . Ad esempio, se eseguo lo strumento con opzioni errate, potresti voler visualizzare un errore, ad esempio Use --help for usage , questo appartiene a stderr . Se eseguo lo strumento con un'opzione valida --help , utilizza stdout .

Se preferisci non avere stringhe di aiuto lunghe vicino al tuo codice, non farlo. #define in un file di intestazione è perfettamente soddisfacente, ma è davvero una preferenza personale. Se dovessi leggere il codice di uno strumento da riga di comando, preferirei che la sua stringa di aiuto fosse all'interno di un file che gestisse le opzioni fornite dall'utente.

Uso la libreria getopts . Per un esempio di aiuto, consulta questo progetto di esempio , in particolare il metodo principale nella parte inferiore di //github.com/srathbun/example-parser/blob/master/parser.y">parser.y.

Se utilizzo C o preferisco non dipendere dalle librerie Boost, quindi rimango con GNU getopt . In caso contrario, preferisco Opzioni del programma di potenziamento che consente di stampare automaticamente.

Ritengo inoltre che l'opzione giusta sia una delle migliori pratiche per quanto riguarda la gestione delle opzioni. L'ho imparato da Git e ora uso lo stesso nei miei progetti. In pratica utilizza la distanza di Damerau-Levenshtein per stampare le corrispondenze migliori se l'utente inserisce qualche opzione della riga di comando sconosciuta.

Ho scritto un piccolo articolo su questo che puoi usare come esempio.

Spero che aiuti:)

Ovviamente, scrivere una pagina buca nel codice cout < < o printf () è complicato, in particolare se devi modificare e riempire nuovamente i paragrafi. Quindi, è ovviamente una buona idea modificare quel testo in un file separato, usando ad esempio emacs dove puoi facilmente formattare il testo.

Quindi puoi utilizzare il seguente script sed per convertire quel file di testo in un file di intestazione C legale:

s/\"/\\"/g
s/$/\n"/
s/^/"/
1i\
const char *helpStr = 
$a\
;

Quindi, su #include -inserendo il tuo file di intestazione nel codice sorgente, puoi semplicemente scrivere il tuo testo usando

cout << helpStr;