√ Mudah! Cara Menulis Komentar di PHP dan Contohnya

Halo semuanya, pada artikel ini badoystudio akan mengulas tutorial bagaimana cara menulis komentar di PHP. Untuk kamu yang sedang mempelajari bahasa pemrograman PHP, artikel ini bisa kamu jadikan referensi untuk menambah insight. Seperti apa cara membuat komentar di PHP? Simak selengkapnya melalui bahasan berikut ini.

Daftar Isi

3 Alasan Pentingnya Menulis Komentar di dalam Pemrograman

Memberikan catatan atau komentar pada baris kode yang sudah kita tulis menggunakan bahasa pemrograman PHP atau lainnya ternyata cukup penting. Benarkah begitu? Betul sekali, karena setidaknya ada beberapa alasan kenapa penulisan komentar ini begitu penting, yaitu adalah sebagai berikut :

Sebagai Pengingat

Sudah fitrahnya kalau manusia adalah pelupa, kalau kamu menulis suatu script atau baris kode dan beralih ke script lain hari ini, mungkin besok atau 1 minggu kemudian kamu masih ingat mengenai fungsi dari script tersebut.

Beda lagi ceritanya kalau membuka script tersebut setelah 1 bulan kemudian atau 1 tahun kemudian. Kemungkinan besar kita lupa akan fungsi dari script yang kita tuliskan hari ini. Itu sebabnya memberikan catatan atau komentar pada script di bagian tertentu bisa dijadikan sebagai pengingat yang bagus.

Memudahkan Orang Lain

Ini sangat penting jika kamu bekerja dalam sebuah tim. Script atau baris kode yang dishare ke public yang sudah disisipi komentar atau catatan akan memudahkan programmer lain mengenai fungsi dari script yang kamu tulis.

Menandai Bagian Tertentu

Pada framework dan CMS tertentu seperti WordPress, penulisan catatan atau komentar ini menjadi wajib ditulis, karena digunakan untuk menandai bagian tertentu yang akan dibaca aplikasi. Ini juga akan memudahkan programmer memahami struktur dan fungsi dari script yang ada pada suatu framework ataupun CMS.

Cara Menulis Komentar di PHP dengan Mudah

Sekarang kita akan mempelajari tanda atau kode untuk membuat komentar di PHP dan juga contoh penerapannya pada script PHP.

Tanda / Kode untuk Menulis Komentar di PHP

Ada 3 Tanda yang bisa dipakai untuk menulis komentar pada pemrograman PHP, yaitu :

Tanda // (Model C++) : tanda ini biasanya digunakan untuk membuat komentar atau catatan yang hanya satu baris
Tanda # (Model Unix Shell) : tanda ini juga bisa digunakan untuk membuat komentar atau catatan yang hanya satu baris
Tanda /* (Model C) : tanda ini digunakan untuk membuat komentar lebih dari satu baris

Menulis Komentar Satu Baris (inline – comment)

Berikut ini contoh penulisan catatan atau komentar di PHP menggunakan tanda // :

<?php

$host="localhost"; // biasanya localhost
$username="root";
$password="password123";
$db="login";

mysql_connect("$host", "$username", "$password")or die("koneksi gagal");
mysql_select_db("$db")or die("database tidak bisa dipilih");


// mengambil data username dan password dari index.php
// bila form method nya GET maka ganti POST menjadi GET

$username=$_POST['username'];
$password=$_POST['password'];


// untuk keamanan
$username = stripslashes($username);
$password = stripslashes($password);
$username = mysql_real_escape_string($username);
$password = mysql_real_escape_string($password);

Sedangkan di bawah ini adalah contoh penulisan komentar menggunakan tanda # :

###########################
# menggunakan if else pada PHP
###########################

<?php
$umur = 19;

if ($umur < 18 ){
    echo "Kamu tidak boleh membuka situs ini!";
} else {
    echo "Selamat datang di website kami!";
}
?>

Menulis Komentar Lebih dari Satu Baris (multiline – comment)

Seperti yang sudah disinggung di atas ketika ingin membuat komentar lebih dari satu baris, maka disarankan menggunakan tanda /* untuk awalan dan */ untuk akhirannya, berikut adalah contoh penerapannya dalam salah satu file WordPress yaitu wp-login.php:

<?php

/**
 * WordPress User Page Login
 *
 * Handles authentication, registering, resetting passwords, forgot password,
 * and other user handling.
 *
 * @package WordPress
 */


/** Make sure that the WordPress bootstrap has run before continuing. */
require __DIR__ . '/wp-load.php';


// Redirect to HTTPS login if forced to use SSL.

if ( force_ssl_admin() && ! is_ssl() ) {
    if ( 0 === strpos( $_SERVER['REQUEST_URI'], 'http' ) ) {
        wp_safe_redirect( set_url_scheme( $_SERVER['REQUEST_URI'], 'https' ) );
        exit;
    } else {
        wp_safe_redirect( 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
        exit;
    }
}

Semua komentar atau catatan yang dibuat dengan ketiga tanda di atas nantinya tidak akan diproses alias diabaikan oleh pemrograman PHP.

Rekomendasi Penulisan Komentar yang Populer

Dari tiga tanda atau model penulisan komentar di PHP, yang paling populer dan banyak direkomendasikan dan diaplikasikan pada framework dan CMS yaitu model 1 dan 3.

Kapan Waktu yang Tepat untuk Menulis Komentar di PHP?

Meski terlihat sepele, waktu atau momen ketika kamu menulis komentar juga bisa menentukan seberapa bermanfaatnya komentar tersebut. Berikut beberapa kondisi terbaik untuk menambahkan komentar pada kode PHP kamu:

Saat Menyelesaikan Fungsi Kompleks
Jika kamu menulis fungsi dengan logika bercabang atau banyak kondisi, menambahkan komentar akan memudahkan saat debugging di kemudian hari.
Ketika Menggunakan Shortcut atau Trik Khusus
Kadang kita menulis baris kode dengan teknik yang tidak lazim (misalnya hack atau workaround). Komentar akan membantu developer lain memahami maksud dari pendekatan tersebut.
Sebelum Melakukan Refactoring
Tambahkan komentar penjelas sebelum kamu melakukan refactoring besar. Ini akan membantu menjaga konteks agar tidak hilang saat merombak struktur kode.
Pada Bagian Konfigurasi atau Koneksi
Contohnya seperti koneksi database, API key, atau pengaturan sistem lainnya. Komentar bisa berfungsi sebagai dokumentasi langsung di dalam kode.

Penutup

Itulah ulasan ringkas mengenai cara menulis komentar di PHP. Semoga memberikan insight dan bermanfaat untuk kamu. Jangan lupa share juga ke temanmu yang lainnya supaya manfaatnya tersebar lebih luas lagi.

Layanan kami :

Sumber gambar utama : https://www.digisaurier.de/

Mudah! Cara Menulis Komentar di PHP dan Contohnya