Mezgit (yazılım) - Haddock (software)

Mezgit balığı
Geliştirici (ler)Simon Marlow
İlk sürüm1 Mayıs 2002
Kararlı sürüm
2.8.0 / 2 Eylül 2010
Depo
Bunu Vikiveri'de düzenleyin
YazılmışHaskell
İşletim sistemiÇapraz platform
Platformx86, PowerPC
TürDokümantasyon üretimi
LisansBSD tarzı lisans
İnternet sitesihttp://haskell.org/haddock/

Mezgit balığı bir Bedava, taşınabilir[1] Komut satırı program belgeleri jeneratör için Haskell. Etkilenir IDoc,[2] HDoc,[3] ve Doxygen.[4] Ürettiği köprülü HTML ek açıklamalı Haskell'den dosyalar (dokümantasyon, yorumlar ) kaynak dosyaları, buradan alınan ek bilgilerle ek açıklamalar yazın; yalnızca kısmen belge oluşturmayı destekler SGML.[5] Genellikle ile birlikte kullanılır Darcs ve Cabal. Bağlıdır Glasgow Haskell Derleyici (GHC), değiştirilmiş bir HsParser formunu kullanarak ( Mutlu ) ayrıştırıcı Haskell için GHC'ye dahildir.[5] Hafif biçimlendirmesi IDoc'lara dayanmaktadır.[5] Mezgit, Haskell Platformu.

GHC, Gtk2Hs ve HTk projeleri tarafından kullanılır,[6] Hem de XMonad.[kaynak belirtilmeli ]

İşte bir Haddock işaretlemesi örneği:

 - | Bu, 'kare' için dokümantasyondur. - "Prelude" dan (*) operatörünü kullanır. - @ x @ argümanını kendisine karşı çarpar. Meydan :: Tamsayı -> Tamsayı Meydan x = x*x

Referanslar

  1. ^ Mezgit çalışıyor POSIX uyumlu işletim sistemleri ve Microsoft Windows.
  2. ^ "IDoc Kılavuzu - Kurulum". www.cse.unsw.edu.au.
  3. ^ "Armin Größlinger Ana Sayfası". www.fmi.uni-passau.de.
  4. ^ "1.3. Katkıda Bulunanlar". haskell.org.
  5. ^ a b c "Haddock: Bir Haskell Dokümantasyon Aracı" Arşivlendi 2006-10-11 Wayback Makinesi - (Simon Marlow tarafından, Haskell'deki ACM SIGPLAN çalıştayının bildirileri, 2002; PDF )
  6. ^ "Haddock, yeni hiyerarşik Haskell kitaplıklarını belgelemek için kullanılıyor. GHC'nin en son sürümüyle birlikte gönderilen kitaplıklar için oluşturulan belgeler burada. Gtk2Hs projesi, referans belgeleri oluşturmak için Haddock kullanıyor. HTk projesi, kitaplığını oluşturmak için Haddock kullanıyor belgeler. " Mezgitten anasayfa.

Dış bağlantılar