"Enter"a basıp içeriğe geçin

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.
Sandcastle Kurulum 1

Next

Sandcastle Kurulum 2

Next

Sandcastle Kurulum 3

Next

Sandcastle Kurulum 4

Next

Sandcastle Kurulum 5

Next

Sandcastle Kurulum 6

Next

Sandcastle Kurulum 7

Next

Sandcastle Kurulum 8

Install Package, yüklendikten sonra Next

Sandcastle Kurulum 9

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

Sandcastle Kurulum 10

Tamam(OK)

Sandcastle Kurulum 11

Tamam(OK)

Sandcastle Kurulum 12

Install Sneppets

Sandcastle Kurulum 13

Tamam(OK) Sandcastle Kurulum 14

Tamam(OK) Sandcastle Kurulum 15

Next

Sandcastle Kurulum 16

Close diyip yüklemeyi tamamlıyoruz

Sandcastle Kurulum 17

 

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

Sandcastle Örnek 1

 

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.

 

Sandcastle Örnek 2

Yeni döküman projeyi ekleyelim.

Sandcastle Örnek 3

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

Sandcastle Örnek 4

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

Sandcastle Örnek 5

“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 Örnek 6

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

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

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

Sandcastle Örnek 9

“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.

Sandcastle Örnek 10

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

Sandcastle Örnek 11

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

Sandcastle Örnek 12

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

Sandcastle Örnek 13

 

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

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

Sandcastle Örnek 15

“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.

Sandcastle Örnek 16

 

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.Sandcastle Örnek 17

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

Sandcastle Örnek 18

 

Ö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.

İlk Yorumu Siz Yapın

Bir Cevap Yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir