Kullanım mesajı - Usage message
 | Bu makalenin birden çok sorunu var. Lütfen yardım et onu geliştir veya bu konuları konuşma sayfası. (Bu şablon mesajların nasıl ve ne zaman kaldırılacağını öğrenin) (Bu şablon mesajını nasıl ve ne zaman kaldıracağınızı öğrenin)
|
İçinde bilgisayar Programlama, bir kullanım mesajı veya yardım mesajı bir program tarafından görüntülenen kısa bir mesajı ifade eder. komut satırı arayüzü yürütme için. Bu mesaj genellikle program için doğru komut satırı kullanımından oluşur ve doğru mesajın bir listesini içerir. komut satırı argümanları veya seçenekler söz konusu program için kabul edilebilir.
Kullanım mesajları, bir programın kullanıcıyı doğru komut konusunda bilgilendirmesinin hızlı bir yolu olarak kullanılır. sözdizimi ve uygun hata mesajları veya örneğin bir man sayfası.
Desen
Unix benzeri platformlarda, kullanım mesajları genellikle aynı ortak modeli izler:
- Genellikle "Kullanım:" komutuyla başlarlar ve ardından bir argümanlar.
- İsteğe bağlı argümanları belirtmek için, Köşeli parantez yaygın olarak kullanılır ve birlikte belirtilmesi gereken parametreleri gruplamak için de kullanılabilir.
- Gerekli argümanları belirtmek için, Açılı parantezler köşeli parantezlerle aynı gruplama kurallarına göre yaygın olarak kullanılır.
- Münhasır parametreler ile ayırarak gösterilebilir dikey çubuklar gruplar içinde.
Örnekler
İşte temel alan bir örnek NetBSD kaynak kodu stil kılavuzu:
Kullanım: program [-aDde] [-f | -g] [-n sayı] [-b b_arg | -c c_arg] req1 req2 [opt1 [opt2]]Bu, "programın" şu şekilde çağrılması gerektiğini gösterir:
- işlenenleri olmayan seçenekler: a, D, d, e (bunlardan herhangi biri ihmal edilebilir). Bu durumda bazı parametrelerin büyük / küçük harfe duyarlı olduğunu unutmayın.
- özel seçenekler: f, g (dikey çubukla gösterilir)
- işlenenlerle seçenekler: n
- işlenenlerle özel seçenekler: b, c
- gerekli bağımsız değişkenler: req1, req2
- opt2 ile veya opt2 olmadan kullanılabilen isteğe bağlı bağımsız değişken opt1 (grup içinde başka bir köşeli parantez kümesi kullanılarak isteğe bağlı olarak işaretlenmiştir)
- tercih1 gerektiren isteğe bağlı seçenek tercih2
Uygulama
Bir kullanım bildirimini yazdırmak için kabuk komut dosyası şöyle yazabilir:
durum "$ arg" içinde ... h) printf 'Kullanım:% s parametre1 parametre2 ... n' "$(ana isim "$0")" çıkış 0 ;;...esacAnti-desenler
Kullanım ifadesi bir hata mesajı değildir, ancak genellikle yararlı bir hata mesajı yazdırmaktan kaçınmanın tembel bir yolu olarak kullanılır. Düzgün yazılmış bir komut satırı programı, kullanım bildirimini yazdırmak ve kullanıcının hatanın ne olduğunu anlamasını istemek yerine, arayan tarafından yapılan hatayı tam olarak açıklayan kısa bir hata mesajı yazdıracaktır. Bir kullanıcı doğru sayıda bağımsız değişkeni iletemezse, örneğin, bir bağımsız değişkenin eksik olduğunu belirten tek bir satır, genel bir kullanım sağlayan birkaç çıktı sayfasından çok daha yararlıdır. Sonuç olarak, bir kullanım ifadesi yalnızca kullanıcı tarafından özel olarak talep edildiğinde (--help, veya -h veya -? Veya benzer bir bayrak veya argüman aracılığıyla) yazdırılmalı ve standart çıktıya yazılmalıdır.[kaynak belirtilmeli ].