I-BEGO

Selamat Sore .

saya sering melihat code-code program , tapi saya sering sulit untuk memahaminya . .
pertanyaan saya :

1.Bagaimana cara membaca source code dengan baik dan benar supaya kita paham ?

2.dan apa harus ditulis ulang dalam bahasa manusia lagi ?

terima kasih .

Pertanyaan yang bagus sekali oom...

Agar bisa di baca dengan baik dan mudah dipahami, mau tidak mau adalah yang menulis kode harus menulis dengan struktur yang mudah dibaca.
Dari sinilah biasanya, tingkat profesionalitas (bukan tingkatan ilmu lho...) seorang pemrogram dapat dilihat..


Coba bandingkan ini :
Biasanya orang yang baru belajar pemrograman penulisannya kadang-kadang bisa seperti ini :

Code: Select all

if (x==3) {
while (n == 3)
{
n++; update_ajah();
}
} else if (x == 8) { deleteIni();
HapusNama(); }


* tidak melihat programnya jalan atau tidak

Kalau orang macam om vberror13, atau om gyus, atau bahkan om trail. Pasti nulisnya gampang di baca seperti ini :

Code: Select all

if (x==3)
{
    while (n == 3)
    {
        n++; update();
    }
}
else if (x == 8)
{
    delete();
    hapus();
}


Intinya agar mudah dibaca, gaya penulisan program harusnya konsisten dan tetap. Akan lebih membantu lagi apabila dikasih tambahan comment2 pada tiap-tiap barisnya.
Mungkin om-om yang lain jg mau menambahkan...

flack wrote:Kalau orang macam om vberror13, atau om gyus, atau bahkan om trail. Pasti nulisnya gampang di baca seperti ini :

, ah nggak gitu. oom. kalo untuk baris diatas, saya tulis kayak gini:

Code: Select all


    if (intTransactionCode == 3 )
    {
        while (intTransactionItemNumber  < 3)
        {
            intTransactionItemNumber ++;
            commitTransaction();
        }
    }
    else if (intTransactionCode  == 8)
    {
        deleteTransaction();
    }



sorry, saya ubah dikit kodenya, karena

Code: Select all

while (n == 3)
    {
        n++; update();
    }


kayaknya percuma deh. mending

Code: Select all

    if (n == 3)
    {
        update();
    }


Mungkin saya terlalu boros memakai karakter dalam penamaan variabel dsb. Tapi dengan demikian saya nggak perlu susah payah mengingat peruntukan variabel tersebut dan type datanya apa.

back to topic (yang di atas itu OOT )

Achmadpdam wrote:1.Bagaimana cara membaca source code dengan baik dan benar supaya kita paham ?

Saya rasa nggak ada resep yang jitu, oom, kecuali rajin membaca dan menulis source code. Dengan rajin membaca, kita bisa memahami source code itu dengan sendirinya. Dengan menulis, kita terbiasa membuat aliran perintah program, trik dan teknik yang lebih baik dan gampang memahami source code orang lain.

terima kasih para mas-mas yang menjawab .

jadi intinya sering membaca source code dan menulis source code aja ya om .
tapi kadang-kadang ada istilah-istilah dalam kode program yang sama sekali tidak saya mengerti
seperti ( misalnya ofset e_magic number ,dll )
sehingga saya jadi malas membacanya lagi ( karena saya sama sekali tidak mengerti istilahnya )
itu bagaimana pemecahannya mas-mas ??

terima kasih sebelumnya .

@om.vberror13
Kan disitu juga sudah ditulis bahwa tidak melihat programnya jalan atau tidak....

@Achmadpdam
kalau saya biasanya, ngeliat definisi-definisi fungsi yg dipanggil tersebut.
Tapi kadang2 juga kalau terlalu aneh bahasanya jg bingung juga...

kalau saya biasanya, ngeliat definisi-definisi fungsi yg dipanggil tersebut.
Tapi kadang2 juga kalau terlalu aneh bahasanya jg bingung juga...

nah itukan masalahnya om . saya jadi bingung tambah mumet .

Keyword/function yang ada dalam kode program biasanya sudah cukup dikenal, bila kita mendalami bahasa program tersebut. Dulu waktu mulai belajar bahasa program, saya banyak meluangkan waktu untuk membaca nama-nama fungsi yang ada di bahasa program tersebut. Kalo untuk vb6 misalnya, saya rajin menyempatkan diri membaca keywords/function yang ada di vb6 IDE. Kalo nggak salah di menu View > Object Explorer. Saya baca nama-nama function yang ada dan kadang mencobanya lewat immediate window. Begitu juga untuk bahasa PHP. Saya download php manual dan membaca hampir seluruh isi manual tersebut. Kurang kerjaan sekali, bukan ?

Tapi intinya saya jadi tahu mana yang *perintah/keyword* asli bahasa program tersebut, dan mana yang bukan. Kalo bukan dari bahasa asli, setidaknya saya harus tahu framework atau object mana yang memiliki keyword tersebut. Lalu cari tahu fungsi dan kegunaannya. Bila kita menemukan keyword yang berasal dari framework, coba lihat manual di framework tersebut.

Lalu yang terpenting adalah mengenal alur perintah yang ada. Misalnya dari mana perintah pertama di mulai dan di mana berakhirnya. Jangan membaca kode program per sub routine/ function. Cape nanti. Mending baca satu sub routine, ikuti alurnya, lompat ke sub routine yang ada dalam alur tersebut bila kita tidak tahu fungsinya, balik lagi ke alur utama, dan seterusnya.

Jadi sama ajalah kayak kita membaca novel-novel Kho Ping Hoo yang penuh dengan istilah-istilah dunia kang-ouw. Kalo ada istilah yang nggak kita mengerti, tebak aja dulu artinya. nanti juga pasti mengerti sendiri.

Post vberror13 telah mendapat kopi dari:

arizane

iktan nimbrung ...

Code: Select all

1.Bagaimana cara membaca source code dengan baik dan benar supaya kita paham ?

ini tergantung pemahaman om sendiri , kadang sewaktu membaca source kita bisa mendapatkan Key baru
dimana nantinya bisa menambah pengetahuan kita

2.dan apa harus ditulis ulang dalam bahasa manusia lagi ?

hmm...code yang baik itu code yang bisa menjadi dokumentasi tersendiri :

Contoh Penggunaan Variabel :
VB :

Code: Select all

Dim i as integer
For i = 0 to 10
  Msgbox "Nomor : " & i
next i


PHP :

Code: Select all

  $i = 0;
  For ($i = 0; $i<=10; $i++) {
   echo "Nomor : ".$i;
  }


dari contoh di atas apakah variable "i" itu bisa menjelaskan maksudnya ??
bagai mana bila diubah menjadi
VB :

Code: Select all

Dim NomorUrut as integer
For NomorUrut = 0 to 10
  Msgbox "Nomor : " & NomorUrut
next i


PHP :

Code: Select all

  $NomorUrut  = 0;
  For ($NomorUrut  = 0; $NomorUrut <=10; $NomorUrut ++) {
   echo "Nomor : ".$NomorUrut ;
  }


menurut om enak membaca code yang mana ??

Contoh Penggunaan Function :
VB :

Code: Select all

Private / Public Function Hit(byval x as integer, byval y as integer) as integer
   Hit = x + y
end function


dari contoh di atas apakah nama function itu bisa menjelaskan maksudnya ??
bagai mana bila diubah menjadi

VB :

Code: Select all

Private / Public Function PenjumlahanNilai(byval pNilai1 as integer, byval pNilai2 as integer) as integer
   PenjumlahanNilai= pNilai1 + pNilai2
end function


menurut om enak membaca code yang mana ??
kita berada dibagian mana ???? yang mendokumentasikan code itu sendiri atau .... ????

trail wrote:hmm...code yang baik itu code yang bisa menjadi dokumentasi tersendiri :

setujuuuu ooommmm!