Bu, Ubuntu Online, Fedora Online, Windows çevrimiçi emülatörü veya MAC OS çevrimiçi emülatörü gibi birden fazla ücretsiz çevrimiçi iş istasyonumuzdan birini kullanarak OnWorks ücretsiz barındırma sağlayıcısında çalıştırılabilen yardoc komutudur.
Program:
ADI
yardoc - Ruby programlama dili için dokümantasyon oluşturmaya yönelik Ruby aracı
SİNOPSİS
yarddoc [seçenekleri] [kaynak dosyaları [- ekstra_dosyalar]] yarda dok [seçenekleri] [kaynak dosyaları [-
ekstra_dosyalar]]
AÇIKLAMA
yarda(1) Ruby programlama dili için genişletilebilir bir belge oluşturma aracıdır.
Kullanıcının bir bilgisayara aktarılabilecek tutarlı, kullanışlı belgeler oluşturmasını sağlar.
çok kolay format sayısı ve ayrıca aşağıdaki gibi özel Ruby yapıları için genişletmeyi destekler
özel sınıf düzeyi tanımları olarak.
yardak, eşanlamlısı yarda dok listesinden belgeleri oluşturur kaynak dosyaları. Eğer
bu liste çıkarılmıştır, "{lib,app}/**/*.rb ext/**/*.c" kullanılmıştır.
Bir temel seçenek kümesi, bir eklenerek belirtilebilir. .yardopts temel yolunuza dosya
boşluklarla ayrılmış tüm ekstra seçenekleri içerir.
SEÇENEKLER
Genel Opsiyonlar
-b, --db DOSYA
Yüklemek veya kaydetmek için belirtilen bir .yardoc veritabanını kullanın (varsayılanı .yardoc'tur)
--[yok hayır-]tek veri tabanı
Kod nesnelerinin tek bir veritabanı dosyasında saklanıp saklanmayacağı (gelişmiş)
-n, --çıktı yok
Yalnızca .yardoc veritabanı oluşturun, belge yok.
-c, --kullan-önbellek [DOSYA]
Dokümantasyon oluşturmak için önbelleğe alınmış .yardoc veri tabanını kullanın (varsayılan olarak önbellek yoktur)
--önbellek yok
Kaynağı ayrıştırmadan önce .yardoc db'yi temizleyin.
--[yok hayır-]yardopts [DOSYA]
Bağımsız değişkenlerin FILE'dan okunması gerekiyorsa (varsayılanı evet'tir, FILE varsayılanı .yardopts'tur)
--[yok hayır-]belge
Bağımsız değişkenlerin .document dosyasından okunması gerekiyorsa (varsayılan olarak evet'tir)
--kaydetme yok
Ayrıştırılan verileri yardoc veritabanına kaydetmeyin
--hariç tutmak regexp
Yol eşleşmesiyle (regexp) eşleşiyorsa dosyayı yok sayar
Çıktı seçenekleri
--tek dosya
Tek bir dosya olarak çıktı üretir
--liste
Standart dışı bırakılacak nesneleri listeleme (ima eder) -n)
--kamuya açık değil
Genel yöntemleri gösterme. (varsayılan olarak herkese açık olarak gösterilir)
-- korumalı
Korunan yöntemleri göster. (varsayılan korumalı gizler)
--özel
Özel yöntemleri göster. (varsayılan özel olanı gizler)
--no-özel
@private etiketiyle nesneleri gizleyin
--[hayır-]api API
Belirli bir API (doğru @api etiketini tanımlayan nesneler) için belgeler oluşturur.
If --api yok verilirse @api etiketi olmayan nesneleri görüntüler.
--embed-karışımlar
Karıştırma yöntemlerini sınıf belgelerine yerleştirir
--embed-mixin [MODÜL]
Belirli bir modüldeki karıştırma yöntemlerini sınıf belgelerine yerleştirir
--no-vurgulama
Çıktıda kod bloklarını vurgulamayın.
--varsayılan-dönüş TİP
Yöntemin dönüş türü yoksa gösterilir. (varsayılanı 'Nesne'dir)
--hide-void-return
'Void' olarak belirtilen dönüş türlerini gizler. (varsayılan gösterilir)
--sorgu SORGU
Yalnızca belirli bir sorguyla eşleşen nesneleri göster
--Başlık BAŞLIK
HTML belgelerine belirli bir başlık ekleme
-r, --beni oku, --ana DOSYA
Dokümantasyonun başlık sayfası olarak kullanılan benioku dosyası.
--Dosyalar DOSYA1,DOSYA2, ...
Eklenecek ekstra virgülle ayrılmış statik dosyalar (ör. SSS)
--varlık DAN[:TO]
Oluşturulduktan sonra çıktı dizinine kopyalanacak bir dosya veya dizin
-o, --çıktı-dir PATH
Çıkış dizini. (varsayılanı ./doc'tur)
-m, --işaretleme İŞARETLEME
Belgelemede kullanılan tekstil, işaretleme veya rdoc gibi işaretleme stili (varsayılanı rdoc'tur).
-M MARKUP_PROVIDER
İşaretlemeyi işlemek için kullanılan kitaplığı geçersiz kılar
--işaretleme-sağlayıcı
biçimlendirme (mücevher adını belirtin)
--karakter seti ENC
Dosyaları ayrıştırırken kullanılacak karakter seti (varsayılan, sistem yerel ayarıdır)
-t, --şablon ŞABLON
Kullanılacak şablon. (varsayılanı "varsayılan"dır)
-p, --şablon-yolu PATH
Şablonların aranacağı şablon yolu (-t ile birlikte kullanılır).
-f, --biçim FORMAT
Şablonun çıktı biçimi (varsayılanı html'dir).
--hiç istatistik
İstatistikleri yazdırma
--yerel ayar YEREL
Oluşturulan belgelerin yerel ayarı (varsayılanı en'dir).
--po-dir DIR
.po dosyalarının bulunduğu dizin (varsayılanı #{YARD::Registry.po_dir} şeklindedir).
Etiket seçenekleri:
(TAG:BAŞLIK şuna benziyor: 'aşırı yükleme:aşırı yüklenmiş Yöntem')
--etiket TAG:BAŞLIK
Yeni bir serbest biçimli meta veri @tag'ini kaydeder
--type-etiketi TAG:BAŞLIK
İsteğe bağlı türler alanına sahip etiket
--tip-ad-etiketi TAG:BAŞLIK
İsteğe bağlı türler ve ad alanı içeren etiket
--isim etiketi TAG:BAŞLIK
Ad alanıyla etiketleyin
--title-tag TAG:BAŞLIK
Başlık alanı olarak ilk satırı içeren etiket
--hide-etiketi TAG
Önceden tanımlanmış bir etiketi şablonlardan gizler
--geçişli-etiket TAG
Bir etiketi geçişli olarak işaretler
--geçişsiz-etiket TAG
Bir etiketi geçişsiz olarak işaretler
Diğer seçenekleri:
-e, --yük DOSYA
Komutu çalıştırmadan önce yüklenecek bir Ruby betiği.
--Eklenti EKLENTİ
Bir YARD eklentisi yükleyin (`yard-' ön ekine sahip mücevher)
--miras
Eski tarz Ruby ayrıştırıcısını ve işleyicilerini kullanın. 1.8.x'te her zaman açık.
--güvenli
Bu örnek için güvenli modu etkinleştirin
-q, --sessizlik
Hiçbir uyarı gösterme.
--ayrıntılı
Daha fazla bilgi göster.
- hata ayıklama
Hata ayıklama bilgilerini göster.
--geri izleme
Yığın izlerini göster
-v, --versiyon
Sürümü göster.
-h, --yardım et
Bu yardımı göster.
ÖRNEKLER
yardak -o "belgeler/" - "SSS" "LİSANS"
Yukarıdaki örnek, "lib/**/*.rb" içindeki dosyalara ilişkin belgelerin "documentation/" dizinine çıktısını verir.
ekstra "SSS" ve "LİSANS" dosyaları dahil.
Onworks.net hizmetlerini kullanarak yardoc'u çevrimiçi kullanın
