mdoc - Bulutta Çevrimiçi

Program:

ADI

mdoc - Mono dokümantasyon yönetim aracı

SİNOPSİS

MDOC komuta [seçenekleri] [args]

MDOC montaj tabanlı bir dokümantasyon yönetim sistemidir.

MDOC belgelerin oluşturulmasına ve güncellenmesine izin verir koçanları içeriğine dayalı bir
toplantı. Kaynak kodunda bulunan belgelere dayanmaz.

Avantajlar:

* Kod okunabilirlik. İyi belgeler genellikle (a) ayrıntılıdır ve (b) doldurulur
örneklerle. (Karşılaştırma için Microsoft .NET Framework belgelerini karşılaştırın,
genellikle her üye için bir sayfa veya daha fazla belge olan JavaDoc belgelerine,
bu genellikle her üye için bir cümle olabilir.)

Kaynak koduna iyi belgeler eklemek, kaynağı sık sık şişirebilir
dosya, çünkü belgeler gerçek yöntemden daha uzun olabilir
Belgeledi.

* Yerelleştirme. Kaynak içi belgeleme biçimleri (ör. csc / doc) desteği yok
birden fazla insan dili için. Birden fazla insan dilini desteklemeniz gerekiyorsa
dokümantasyon amaçlı, MDOC her dilin çıktısına izin verdiği için kullanışlıdır.
kendi dizininde bulunur ve MDOC her biri için türler/üyeler ekleyebilir
dokümantasyon dizini.

* İdaresi. Ayrı belgelere ve geliştirmeye sahip olmak alışılmadık bir şey değil
takımlar. Dokümantasyon ekibinin minimum deneyime sahip olması da mümkündür.
kullanılan programlama dili ile. Bu gibi durumlarda, satır içi
dokümantasyon ekibi istemeden ekleyebileceğinden dokümantasyon istenmez
belgeler güncellenirken kaynak kodunda bir hata oluştu. Alternatif olarak,
dokümantasyon ekibinin güvenlik için kaynak koduna erişmesini istemeyebilir
nedenler. MDOC belgelerin saklanmasını sağlar tamamen ayrı ve farklı
montajı oluşturmak için kullanılan kaynak koddan.

Belgeler kullanılarak oluşturulabilir MDOC güncelleştirme komut:

mdoc update -o docs/tr ProjeAdı.dll

Belge taslakları oluşturulduktan sonra (ve umarım daha sonra
gerçek belgeler), belgeleri görüntülemenin üç yolu vardır:

* Basit bir HTML sayfaları dizini (her tür için bir HTML dosyası) oluşturmak için şunu kullanın: MDOC
ihracat-html:

mdoc dışa aktarma-html -o /srv/www/htdocs/ProjeAdı docs/tr

* Kaynakları görüntülemek üzere bir ASP.NET web uygulaması kullanmak için bkz.: http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

Bir itibaren tek belge kaynak kontrol, bunu yapabilirsiniz:

cd motoru
ağ yapmak

Bu kullanacak xsp(1) ASP.NET web uygulamasına hizmet vermek için; Ziyaret http://localhost: 8080 / için
belgeleri görüntüleyin.

* Kullanmak için tek belge(1) dokümantasyon tarayıcısı, önce birleştirmek the
belgeler:

mdoc birleştirme -o ProjeAdı docs/tr

Yukarıdaki komut dosyaları oluşturur ProjeAdı.ağaç ve ProjeAdı.zip. Bir
ek ProjeAdı.kaynaklar nerede olduğunu açıklayan dosya sağlanmalıdır.
yardım sistemi belgeler bağlanmalıdır; çok basit bir XML dosyasıdır,
bunun gibi:



<source provider="ecma" basefile="ProjectName"
yol="çeşitli" />


Yukarıdaki yapılandırma dosyası, belgelerin ECMA biçiminde olduğunu açıklar,
temel dosya adı olduğunu Proje Adı ve içine bağlanması gerektiğini
"çeşitli" dokümantasyon ağacının bir parçası. Çeşitli düğümlere bakmak istiyorsanız
belgelerde tanımlanan, bakabilirsiniz monodoc.xml olan dosya
tipik olarak yüklü /usr/lib/monodoc/monodoc.xml.

Gerekli tüm dosyalara (.zip, .tree ve .sources) sahip olduğunuzda, yükleyebilirsiniz.
bunları aşağıdaki komutla sisteme girin:

cp ProjeAdı.ağaç ProjeAdı.zip ProjeAdı.kaynak \
`pkg-config monodoc --değişken kaynaklardir'

Yukarıdakiler, dosyaları Monodoc'un kaydettiği dizine kopyalayacaktır; sen
Bunu yapmak için kök izinlerine ihtiyaç duyabilir. Gerçek dizin tarafından döndürülür
pkg-config çağırma.

MDOC KOMUTLAR

MDOC birleştirmek
içinde kullanılmak üzere belgeleri derler. tek belge(1) tarayıcı.

Bak mdoc-birleştirme(1) ayrıntılar için kılavuz sayfası.

MDOC ihracat-html
Belgeleri HTML dosyalarının bir dizin yapısına aktarır.

Bak mdoc-dışa aktarma-html(1) ayrıntılar için kılavuz sayfası.

MDOC ihracat-msxdoc
Belgeleri tek dosyaya aktarır Microsoft XML belgeleme biçimi.

Bak mdoc-dışa aktarma-msxdoc(1) ayrıntılar için kılavuz sayfası.

MDOC yardım et
Belirli bir komut için dahili yardımı görüntüleyin.

mdoc yardım toplama

şuna eşittir:

mdoc birleştirme -- yardım

Birden çok alt komut aynı anda listelenebilir:

mdoc, dışa aktarma-html güncelleme doğrulamasının birleştirilmesine yardımcı olur

MDOC güncelleştirme
Belgeleri günceller, bir referans derlemesine dayalı olarak üyeler ekler ve kaldırır.

Bak mdoc güncellemesi(1) ayrıntılar için kılavuz sayfası.

MDOC onaylamak
Belgeleri Mono belge şemasına göre doğrular.

Bak mdoc doğrulama(1) ayrıntılar için kılavuz sayfası.

onworks.net hizmetlerini kullanarak mdoc'u çevrimiçi kullanın