[Beginner] Commenting

DISCUSSION MOVED TO NEW FORUM
http://gmindo.web.id/forum/showthread.php?tid=53



Commenting berguna sebagai pengingat yang membantu kita jika kita telah selesai menyelesaikan coding dan kembali di lain waktu.

Ada 2 macam bentuk komen di GML, yaitu dengan // (untuk satu baris) atau dengan pasangan /* dan */ untuk lebih dari satu baris. Tip: jika anda menggunakan /// pada baris paling atas code pada action suatu resource, maka apa yang anda tulis sebagai komen akan muncul di window action.


Yang baik:
Komen yang baik adalah komen yang jelas dan -secukupnya-, biasanya di atas suatu perintah penting atau satu "blok" perintah.

Contoh:

Code:


    /// Script untuk surface

    /*
    Script surface_script_light dipanggil saat awal persiapan game.
    Keep it simple!

    */

    // siapkan variabel global
    globalvar light;

    // siapkan surface
    light=surface_create();
    surface_set_target(light);
    draw_clear_alpha(c_black,0.75);
    surface_reset_target();



    // dst


Yang kurang baik:

Apakah ada yang kurang baik mengenai commenting? Ada, namanya overcommenting alias komen berlebihan yang biasanya bukannya membantu tapi malah membingungkan yang membaca. Some people do this (and sometimes I do too).

Contoh:

Code:




    // siapkan var global
    globalvar inventory; // bisa dibaca di semua script!

    var i; // siapkan variabel counter
    i=0; // inisialisasi i dulu

    for (i=0;i<20;i++) // untuk i mulai 0 tapi ngga sampai 20, nambah terus ...
    {
        if (i==0) inventory[i]='pistol' // item awal selalu pistol ...
              else inventory[i]='kosong'; /// yang lainnya kosong
     }

// sekarang kita siapkan array shop




Intinya adalah kalau sudah cukup jelas, maka tidak perlu di-komen. Cukup agar kode tersebut menjadi jelas dibaca.

Tanggapan? Welcome and please post

Nice Tips Again!

agan, apa bedanya antara "//" , "/*" dan "///"?
apa sama aja??

glupfruxx wrote:Nice Tips Again!

agan, apa bedanya antara "//" , "/*" dan "///"?
apa sama aja??

Kalau '//' komennya cuma berlaku untuk 1 line
Kalau '/*' komennya bisa panjang lebaaaaaar.

Well, of course overcommenting makes it useless

Tapi ada sedikit masukan dari saya: untuk algoritma-algoritma yang terkandung di dalamnya, tidak terlalu penting untuk ditambahkan comment kecuali ada bagian2 yang harus dijelaskan..
tapi justru comment itu menjadi penting untuk menjelaskan deskripsi singkat fungsi-fungsi/modul dan parameternya, serta deklarasi variable

oops, sori ke klik yang tanda negatif i kinda like the meme actually


yah benar memang comment juga bisa dipakai sebagai deskripsi singkat fungsi2 beserta parameter, serta deklarasinya. biasanya ditulis di awal fungsi. kadang juga bisa ditambahkan nama pembuat dan tanggal pembuatan yang memudahkan pengembangan atau update.

LOL salah klik

Tambah lagi: on the other way, programmer juga cenderung memanfaatkan commenting untuk keperluan debugging, mis. commenting sementara pada bagian code yang mengakibatkan error atau hasil yang tidak diinginkan.
ya gitu deh kebiasaannya

FisherCS wrote:

glupfruxx wrote:Nice Tips Again!

agan, apa bedanya antara "//" , "/*" dan "///"?
apa sama aja??

Kalau '//' komennya cuma berlaku untuk 1 line
Kalau '/*' komennya bisa panjang lebaaaaaar.

dan jgn lupa kalo pke /* hrus di close pke */
di close berarti komentar ny di akhiri

kalo /// itu utk beri nama pda Execute kode nya,, jdi kalo ///NAMA, maka ada kolom Action terdapat execute dengan nama NAMA

Kevin Blaze Coolerz wrote:

FisherCS wrote:

glupfruxx wrote:Nice Tips Again!

agan, apa bedanya antara "//" , "/*" dan "///"?
apa sama aja??

Kalau '//' komennya cuma berlaku untuk 1 line
Kalau '/*' komennya bisa panjang lebaaaaaar.

dan jgn lupa kalo pke /* hrus di close pke */
di close berarti komentar ny di akhiri

kalo /// itu utk beri nama pda Execute kode nya,, jdi kalo ///NAMA, maka ada kolom Action terdapat execute dengan nama NAMA

Wokeh maskasih mas kevin.. di mengerti

glupfruxx wrote:
Wokeh maskasih mas kevin.. di mengerti

seep kalo gitu