Archive for the ‘Documentation’ tag
Dokumentasi .NET dengan DocProject-Sandcastle (1)
Dokumentasi source code mungkin untuk sebagian teman-teman belum menjadi prioritas dalam bekerja. Apalagi jika kita merupakan seorang single fighter atau hanya terdiri dari tim yang kecil. Namun, dengan penerapan OO pada pekerjaan kita, dokumentasi merupakan sesuatu yang mutlak untuk diperhatikan. Untuk programmer java / php, mungkin sudah terbiasa menggunakan source documentation generator seperti JavaDoc atau PhpDoc.
Namun, bagaimana untuk yang menggunakan microsoft .NET? Untuk .NET, ada beberapa software freeware / commercial yang tersedia seperti N-Doc, VSDocMan, dan yang terakhir Sandcastle. Referensi mengenai perbandingan document generator dapat dilihat di wikipedia. Fokus utama yang akan dibahas di dalam artikel ini adalah Sandcastle dengan menggunakan DocProject. Sandcastle adalah software yang dikembangkan oleh microsoft sebagai alat untuk menghasilkan dokumen program dari komentar-komentar yang ada pada sumber program. Sedangkan DocProject merupakan alat bantu untuk sandcastle, karena menggunakan sandcastle secara manual dirasa cukup merepotkan dan membingungkan. Beberapa alasan untuk menggunakan dua software tersebut adalah sbb:
- Free & Gratis, Sandcastle berlisensi Microsoft Public License, dan DocProject berlisensi GNU/GPL (GPLv2).
- DocProject lebih mudah digunakan, dan masih didukung oleh komunitas.