Burada fiili bir standarttır. Temelde bir komut satırı gibi yardım metni yazıyorum:

usage: app_name [options] required_input required_input2
  options:
    -a, --argument     Does something
    -b required     Does something with "required"
    -c, --command required     Something else
    -d [optlistitem1 optlistitem 2 ... ]     Something with list

Temelde sadece çeşitli araçları yardım metnini okuma yaptım, ama kurallar falan bir liste var mı? Örneğin, köşeli parantez veya parantez kullanırım? Ne aralığı? Parametre listesi ise? Teşekkürler!

Genellikle, yardımcı çıkış içermelidir:

• Bu uygulamanın ne yaptığı açıklaması
• Kullanım sözdizimi:
  • [options] seçenekleri nereye belirtmek için kullanır
  • Gerekli, tekil bir arg için arg_name
  • İsteğe bağlı, tekil bir arg [arg_name]
  • Birçok (bu nadirdir) olabilir gerekli bir arg arg_name…
  • Herhangi bir sayı temin edilebilir bir arg [arg_name…]
  • arg_name açıklayıcı, kısa adı, alt, yılan durumda olması gerektiğini unutmayın
• Seçenekler güzel biçimli bir listesini, her biri:
  • kısa bir açıklama olması
  • eğer bir tane varsa, varsayılan değer gösteriyor
  • olası değerler, eğer geçerliyse) gösteriliyor
  • Unutmayın, eğer bir seçenek olabilir kabul kısa bir formu (örneğin -l) ya da uzun formu (örneğin --list), vardır onlarla birlikte aynı satırda, açıklamaları değişmeyecek
• Komut satırı argümanları kaynağı, örneğin GREP_OPTS olabilecek yapılandırma dosyaları veya ortam değişkeni yeri kısa göstergesi
• Eğer adam bir sayfa varsa, gibi, aksi halde, daha ayrıntılı yardım bulunabileceği kısa bir göstergesi gösterir

İyi bir form bu mesajı tetiklemek için -h --help hem kabul etmek için daha fazla dikkat edinveeğer kullanıcı oynuyorlar eğer bu mesajı göstermek gerekir komut satırı sözdizimi, örneğin gerekli bir argüman atlar.