JSDuck ile kendi Ext JS 4 uygulamalarınızın JavaScript API dokümantasyonunu oluşturun

Merhaba,

Eğer Ext JS 4 kullanarak büyük JavaScript ugulamarı geliştiriyorsanız kodlarınızda JSDoc kullanmanız hayati önem arzeder. Eğer kodlarınızı diğer yazılımcılar ile paylaşıp ekip çalışması yapıyorsanız bu durum daha da önemli hale gelir. Bu gibi durumlarda eğer disiplinli davranıp classlarınızı, methodlarınızı, değişkenlerinizi, dosyalarınızı v.b. güzel dokümante ettiyseniz proje tamamlandıkça bu dokulanları bir API dokumanı haline getirmek gerekir ve bu aşamada çoğu zaman bir araca ihtiyaç duyarız. Biz lab2023 – internet teknolojileri olarak bu sorunun üstesinden gelmek için kendimize Sencha Labs tarafından geliştirilen kendi API dokumantasyonlarını oluşturmak için kullandıkları JSDuck‘ u araç olarak belirledik. JSDuck kullanarak oluşturacağınız API dokumantasyonları Ext JS’ in API dokumantasyonu gibi olacaktır.

       ,~~.
      (  6 )-_,
 (\___ )=='-'
  \ .   ) )
   \ `-' /    hjw
~'`~'`~'`~'`~

Aracın kullanımı ve kurulumu gerçekten çok basit ve temiz. Şimdi size kurulum ve kullanımı ile ilgili birkaç bilgi vereceğim.

JSDuck GitHUB sayfası

https://github.com/senchalabs/jsduck

JSDuck kurulumu

JSDuck bir RubyGem’ dir. Öncelikle sisteminizde ruby programlama dilinin kurulu olması gerekir. Ruby hakkında daha detaylı bilgi için  http://www.ruby-lang.org/tr/ adresini ziyaret edebilirsiniz. RubyGems için ise http://docs.rubygems.org/read/chapter/3 adresi işinizi görecektir.

Ruby’ nin sisteminizde kurulu ve çalışır durumda olduğunu var sayarak, şimdi terminalden aşağıdaki komutu çalıştırın.

$ [sudo] gem install --pre jsduck

Eğer bir sorun yaşamazsanız jsduck gem’i sisteminize kurulacak ve kullanıma hazır hale gelecektir.

Eğer windows kullanıcısı iseniz şu adresi ziyaret ediniz: https://github.com/senchalabs/jsduck/downloads

JSDuck’ın kullanımı

JSDuck sisteminizde bulunan javascript dosyalarınızın bulunduğu tüm alt dizinleri tarar ve içinde js dosyalarını ayrıştırarark yazılmıs JSDoc’ ları Ext JS API dokumantasyonundaki gibi bir arayüz haline saniyeler içerisinde getirir.

jsduck jsduck your/project/js --verbose --output your/docs

Yukarıdakı komutu çalıştırdığınızda jsduck proje dizininizi tarar ve tum JSDoc satırlarını yorumlayarak your/docs dizininize bir Ext JS uygulaması olarak API dokümantasyonunuzu oluşturur.

Buradaki –verbose parametresi dokumanın oluşturulması sırasında konsola çıktıyı basar ve olan biten hakkında sizi bilgilendirir. –ignore-global, global sınıf yaratılmasını önlerken, –exclude Error ise hataların gizlenmesini sağlayacaktır.

(Açıkcası bu parametreleri şimdilik test etmedim :)  ve ingilizcemin yettiği kadarıyla buraya çevirmeye çalıştım. daha sonra test edip burayı güncelleyeceğim)

JSDuck için kodlarınızın dokümante edilmesi

Şu adreste kullanabileceğiniz JSDoc tagları listelenmektedir.  Ama ben yinde aşağıda da listeledim.  JavaScript sınıflarınızı bu kaynakta belirtilen şekilde dokümante ederseniz JSDuck ile çok kullanışlı API dokümantasyonları hazırlayabilir, daha da önemlisi kodlarınızı yorumlayan diğer geliştiricilerin sizi daha rahat anlamasını sağlayabilirsiniz.

Lisanslama ve Kullanım

JsDuck GNU General Public License 3   koşulları altında dağıtılır.
Geliştiricileri ise;
Tabi bu tarz projelerin bir çok katkı sağlacısı olduğunu da unutmamak gerek.
İyi çalışmalar.

About tayfun.ozis.erikan

Web Developer, Graphic & Web Designer Zend Framework, CodeIgniter, ExtJS & Sencha Touch User Kebab Framework Developer The co-founder of lab2023 - internet technologies
This entry was posted in Akıl Defterim, Alet Çantası, Ext JS, JavaScript and tagged , , , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>