Sandcastle Kurulumu ve Kullanımı

Sandcastle Help File Builder bir .Net dökümantasyon aracıdır. Projedeki açıklamaları(
) alıp otomatik msdn documentation gibi her methodun, sınıfın açıklamarını oluşturur. Şimdi gelelim kurulumuna, öncelikle https://github.com/EWSoftware/SHFB/releases adresinden son sürümünü indiriyoruz. Sonra standart Next Next Finish’in yanında birkaç tane “install” işlemimiz olacak.

Next

Next

Next

Next

Next

Next

Next

Install Package, yüklendikten sonra Next

Install Schemas (yüklü olan VS sürümünü seçin)

Tamam(OK)

Tamam(OK)

Install Sneppets

Tamam(OK)

Tamam(OK)

Next

Close diyip yüklemeyi tamamlıyoruz

 

Şimdi Sandcastle’ı Visual Studio ile nasıl kullacağız ona geldi. Visual Studio’da bir Mvc projesi oluşturalım.

 

Not: Change Auhentication’den “No Auhentication” diyin, yoksa Microsoft.Owin’den dolayı döküman derlenirklen beklenmedik bir hata çıkıyor. Çözmekle uğraşmak isteyen ekleyebilir.

 

Yeni döküman projeyi ekleyelim.

Documentation kısmında “Sandcastle Help File Builder Project” i seçelim.

Web projemizin “Properties”(ayarlarına) girelim.

“XML documentation file”a tik koyalım. Otomatik “Outpacth path\Proje adı.Xml” şeklinde dolacak. Ardından sadece web projemizi build edelim ve XML dosyası oluşturmasını sağlayalım.

Sandcastle projemizin açalım. “Documentation Sources” üzerine gelip sağ tıklayalım. “Add Documentation Source”u seçelim.

Web projemizin XML dosyasını oluşturmasını istediğimiz dizine gidip XML dosyasını seçelim.

Gördüğünüz gibi dll dosyasını da otomatik olarak çekti.

“Help content output path” oluşturulan dökümantasyonun çıkaralıcağı dizin, standart olarak Help geliyor. İsterseniz “Fixed path” diyerek “C:\\falan\filan” şeklinde adres verebilirsiniz.

şimdi projemizin “HomeController.cs” dosyasında metotlarımıza açıklama yazıyoruz.

Açıklama satırlarını ekledikten sonra build diyoruz ve Sandcastle dökümanımızı oluşturuyor.

Sandcastle ayarlarında belirtiğimiz “Help” dizinine gördüğümüz gibi döküman dosyamız çıkmış.

 

Döküman dosyamız ve eklediğimiz açıklamalar.

İsterseniz chm formatının dışında da çıktılar üretebilirsiniz. Yine sandcastle ayarlarına girip “Website”ye tik koyalım.

“Help File” ayarlarına girip “Presentation style”ı VS2013 yaptığımızda çıktımız MSDN’nin döküman sayfası gibi olacak. Ayarlarımızı yaptıktan sonra tekrar build edelim.

 

Gördüğümüz gibi hem chm dosyamız oluşturuldu hem de web site formatında dökümantasyon dosyalarımız oluşturuldu.

Gördüğümüz gibi eklediğimiz açıklama satırları çok hoş bir arayüzle karşımızda.

 

Özet olarak, burada bizim web projesi oluşturmamız önemli değil. Önemli olan oluşturuğumuz projenin ayarlarına girip XML formatında dökümantasyon istemek ve bunu Sandcastle projemize eklemek. Bu kadar basit.