Penulisan Komentar Pada PHP

Berikut ini adalah tutorial dasar php penulisan komentar pada php, komentar biasanya di fungsikan untuk dokumentasi kode, penulisan komentar pada php di maksudkan untuk tujuan memberi informasi pada sebuah kode yang di tulis, misalnya sebuah sifat kerja pada sebuah fungsi, atau penulisan informasi sumber koder yang membuat source code tersebut, dan masih banyak lagi. Fungsi komentar ini sangat bermanfaat tetapi sering sekali diabaikan, padahal komentar bisa menjadi pengingat jika anda bermaksud untuk retrospeksi kode yang anda tulis. Sebuah komentar pada bahasa pemrograman apapun tidak akan tampil sebagai output, hanya sebuah teks biasa.

Baca juga:  Menjalankan File PHP di Browser

Cara Penulisan Komentar Pada PHP

Ada beberapa cara penulisan komentar pada PHP dimana gaya penulisan komentar PHP ini sangat di pengaruhi oleh gaya penulisan komentar pada bahasa C, C++ dan Unix Shell dan pada akhir penulisan sebuah komentar tidak perlu menggunakan karakter titik koma atau semicolon, berikut ini beberapa contohnya.

Baca juga:  Aturan Penulisan Kode PHP

Contoh komentar satu baris.

<?php
    // contoh komentar satu baris
?>

Seperti namanya, komentar satu baris ini digunakan apabila penulisan informasi pada sebuah kode tidak membutuhkan banyak teks, misalnya untuk memberi tahu jenis tipe data yang di gunakan “// integer” dan lain-lain.

Contoh komentar lebih dari satu baris

<?php
    /*
      ini adalah sebuah komentar pada php
      yang digunakan apabila banyak informasi
      ditulis di dalamnya
    */
?>

Bisa di tebak, penulisan komentar ini kebalikan dari penulisan komentar gaya pertama, jika sebuah informasi pada kode php membutuhkan banyak teks, anda tidak perlu menulis banyak karakter double slash untuk memuat banyak informasi yang ditulis, cukup gunakan tipe ini.

Contoh komentar gaya Unix Shell

<?php
    # ini adalah komentar Unix Shell
?>

Penulisan komentar dengan cara ini sama saja seperti menggunakan double slash, dimana anda tidak dapat membuat baris baru untuk penulisan komentar jenis ini, anda harus menulis ulang tanda “#” jika ingin memuat informasi banyak didalam komentar.

Contoh Penulisan Sebuah Komentar di PHP

Sebuah komentar tidak akan melakukan proses apapun meskipun didalamnya ditulis sebuah proses, dan karena PHP adalah sebuah bahasa server-side maka anda tidak bisa melihat komentar dengan cara view-source pada browser, komentar PHP tidak akan tampil di browser, berikut ini adalah contohnya.

<?php
    $i = 1; // memberikan nilai 1 pada variabel $i
    echo $i;
?>

Dari contoh diatas sebuah teks yang bertuliskan “memberikan nilai 1 pada variabel $i” tidak akan tampil sebagai output sebuah proses dan hanya akan menampilkan angka 1.

penulisan komentar pada php

Contoh lain dari penulisan komentar pada PHP, misalnya ingin memberikan informasi pada sebuah fungsi tertentu, dimana ingin memberitahu proses yang akan terjadi pada sebuah fungsi.

<?php
    function penambahan($a, $b)
    {
    	/*
    	   ini adalah sebuah fungsi penambahan matematika dasar 
    	   untuk nilai pada variabel $a dan $b.
    	   nilai $a dan $b harus menggunakan tipe data integer.
    	*/
        return $a+$b;
    }

    echo penambahan(1, 2);
?>

Dari contoh kode fungsi di atas yang akan terjadi adalah nilai yang di kirim pada variabel $a dan $b akan melakukan penambahan, sebagai contoh penulis memberikan nilai 1 pada variabel $a dan nilai 2 pada variabel $b, maka yang akan tampil di browser adalah angka 3.

Contoh tersebut adalah contoh dasar sebuah fungsi yang hanya memiliki sedikit proses, bagaimana jika banyak? misalnya pada kasus jika anda menulis kode program sudah satu tahun lamanya, tiba-tiba klien ingin anda mengembangkan kode-kode atau jika terjadi masalah pada kode tersebut. Pada kasus ini tentu kode program yang sudah lama ditulis anda pasti tidak mengingat seluruhnya, disinilah fungsi komentar di butuhkan sebagai pengingat sebuah proses yang berjalan.

  • fetty hardiyanti

    bagus sekali . semoga kmi bisa belajar dengan tulisan anda

    My
    blog