Tutorial – Borland Developer Studio

Wisnu Widiarta – 13 Mei 2006

http://wishknew.mutiply.com/

Membuat Dokumentasi Program dengan Borland

Developer Studio
Membuat dokumentasi program adalah momok nomor satu bagi sebagian besar
programmer, khususnya programmer di Indonesia. (Sayangnya, hal ini sering kali juga
berlaku bagi saya sendiri). Banyak sekali alasan mengapa hal ini terjadi. Berikut adalah
alasan-alasan yang sering dijadikan alasan ketika dokumentasi program ditanyakan oleh
orang yang membutuhkannya:
− Wah nggak ada waktu. Baru mau bikin dokumentasi, udah dikasih kerjaan baru.
Mana sempat?
− Source code saya udah bagus banget. Mestinya kalo liat programnya udah ngerti
− Ntar aja deh. Kalo sempat. (Percayalah, sebagian besar yang menjawab seperti ini
tidak pernah sempat mengerjakannya)
− Kalau yang lain aja gak bikin, kenapa saya harus bikin?
− Dan alasan lain yang intinya adalah malas untuk membuat dokumentasi

Padahal dokumentasi sangat diperlukan, sebagai bahan untuk mempelajari algoritma

suatu program, ketika program akan :
− diteruskan pengembangannya oleh programmer lainnya
− diteruskan oleh programmer itu sendiri beberapa waktu kemudian (sering seorang
programmer bertanya-tanya kepada dirinya sendiri, mengapa dia membuat
penggalan kode program seperti itu)
− dan alasan lainnya

Seperti halnya Java dengan fitur JavaDocnya yang mampu menyulap komentar pada
tubuh program menjadi serangkaian file HTML dengan sangat mudah, kini programmer
Delphi dapat melakukan hal yang sama dengan tool Borland Developer Studio 2006.
Fasilitas ini dapat dilakukan dengan melakukan klik pada Model View dan menekan
tombol Yes pada konfirmasi apakah kita akan menambahkan “modelling support” pada
project yang sedang kita buat.

Secara otomatis jika kita membuat project dengan nama ProjectBangunDatar maka BDS
secara otomatis akan membuat folder di bawah folder project untuk menyimpan model
dengan nama ModelSupport_ProjectBangunDatar.

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 1
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Untuk melakukan desain kelas dengan menggunakan UML atau melihat objek secara
visual pada diagram model, klik suatu objek pada tree Model View.

Berikutnya Anda dapat mencoba hal berikut:

1. Buat sebuah unit baru, namakan dengan classBangunDatar
2. Untuk membuat skeleton kelas, gunakan code mapping dengan mengetikkan class
dan diikuti menekan [CTRL + J]

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 2
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Listing programnya adalah sebagai berikut:

unit classBangunDatar;

interface
type
TBangunDatar = class(TObject)
private
{ private declarations }
protected
{ protected declarations }
public
{ public declarations }
published
{ published declarations }
end;

implementation

end.

Simpan project, dan refresh Model View. Maka Anda dapat melihat diagramnya sebagai
berikut:

Untuk menambahkan field atau method, Anda dapat melakukannya melalui diagram ini.
Klik kanan pada TBangunDatar dan pilih Add Æ function. Otomatis pada source code
unit Anda fungsi yang ditambahkan akan langsung dibuatkan skeletonnya.

Tambahkan fungsi CariKeliling dan CariLuas yang mengembalikan double.

Karena BangunDatar adalah sesuatu yang abstrak, Anda dapat membuat kelas ini abstrak.
Klik pada TBangunDatar, dan tekan F11 untuk menampilkan Object Inspector dari kelas
ini. Pada property abstract set nilainya menjadi true. Kelas ini secara otomatis menjadi
abstract.

Anda dapat menambahkan nama Anda sendiri pada property Author. Nama Anda akan
muncul pada dokumentasi yang akan dihasilkan oleh Model View ini.

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 3
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Informasi yang diketikkan akan muncul sebagai comment pada tubuh program. Anda
dapat membuat comment ini pada editor, dan otomatis nilainya dapat dilihat pada
diagram dan tampil pada dokumentasi.

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 4
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Komentar yang dihasilkan pada program adalah:

unit classBangunDatar;

interface
type
///<stereotype>type</stereotype>
/// <author>Wisnu Widiarta</author>
/// <version>1.0</version>
TBangunDatar = class abstract (TObject)
private
{ private declarations }
protected
{ protected declarations }
public
{ public declarations }
///<output>Mengembalikan nilai keliling dari bangun datar</output>
function CariKeliling: double;virtual;abstract;
function CariLuas: double;virtual;abstract;

published
{ published declarations }
end;

implementation

end.

Untuk menghasilkan dokumentasi, klik kanan pada Model View, dan pilih Generate
Documentation. Scopenya bisa Anda pilih termasuk folder untuk menyimpan hasil
dokumentasinya. Jika ditanya akan membuat folder, jawab Yes.

BDS tidak hanya menghasilkan file HTML yang mirip dengan JavaDoc namun juga
applet untuk navigasinya.

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 5
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 6
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

Overview Namespace Classifier Tree Index Help

PREV NEXT FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | DESTR | METHOD DETAIL: FIELD | CONSTR | DESTR | METHOD

Namespace: classBangunDatar

Class TBangunDatar
System.Object
|
+-- classBangunDatar.TBangunDatar

public class TBangunDatar

extends System.Object
Persistent
False
Stereotype

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 7
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

type
Version
1.0
Author
Wisnu Widiarta
Sealed
False
Abstract
True

Method Summary
public CariKeliling()
function
double
public CariLuas()
function
double

Method Detail
CariKeliling
public function CariKeliling(): double
Class
False
Returns
Double
Reintroduce
False
Output
Mengembalikan nilai keliling dari bangun datar
Abstract
True
Virtual
True
Override
False
Final
False

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 8
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.
Tutorial – Borland Developer Studio
Wisnu Widiarta – 13 Mei 2006
http://wishknew.mutiply.com/

CariLuas
public function CariLuas(): double

Class
False
Returns
Double
Reintroduce
False
Abstract
True
Virtual
True
Override
False
Final
False

Overview Namespace Classifier Tree Index Help

PREV NEXT FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | DESTR | METHOD DETAIL: FIELD | CONSTR | DESTR | METHOD

Bagaimana? Cukup mengesankan, bukan? Anda dapat membuat program dengan bantuan
model view sehingga dapat membuat turunan kelas BangunDatar langsung dari diagram
tersebut. Dokumentasi dapat dibuat langsung pada tubuh program, tidak perlu dilakukan
secara terpisah.

Semoga dengan fitur ini, kita tidak malas lagi dalam membuat dokumentasi program.

Dilarang mengubah, menyalin, atau menggandakan isi dokumen ini tanpa izin pengarang khususnya untuk tujuan komersial. 9
Dokumen ini bebas digunakan untuk kepentingan pribadi saja.