Komentar PHP di bagian yang diperlukan. Komentar dalam HTML, CSS, PHP

Dari penulis: Mengomentari adalah salah satu fitur yang mudah diterapkan. Pada saat yang sama, elemen pengeditan ini dapat memberikan banyak manfaat bagi pengembang yang mentransfer kode dari tangan ke tangan. Hari ini Anda akan belajar cara mengomentari blok di PhpStorm. Kami juga akan mempertimbangkan fungsi yang tersisa dari lingkungan pengembangan untuk mengomentari konten program.

Komentar: buruk dan baik

Kemampuan untuk mengomentari kode tersedia di sebagian besar bahasa pemrograman (mungkin semuanya, tetapi dengan tingkat aksesibilitas yang berbeda-beda). Biasanya, klarifikasi verbal digunakan untuk membantu anggota tim lainnya berkembang lebih jauh, atau sekadar mengingatkan diri sendiri bahwa suatu area memerlukan perbaikan (“PERBAIKI SAYA”).

Tentu saja penjelasan atas apa yang tertulis merupakan berkah. Namun dengan bantuan komentar, Anda dapat mencoret semua aspek baik dari kode tersebut. Untuk mencegah hal ini terjadi, perlu dibedakan jenis-jenis komentar:

mendokumentasikan. Asosiasi yang baik adalah konsep dokumentasi untuk berbagai perangkat lunak. Komentar tersebut membantu dalam menggunakan kode, seperti instruksi. Komentar seperti itu tidak dianggap berlebihan, karena tanpanya tidak ada jalan keluar. Bayangkan seseorang menggunakan kerangka kerja berpemilik dan tidak memberi tahu Anda cara menggunakan program tersebut;

JavaScript. Mulai cepat

penjelasan. Kode yang bagus biasanya tidak membutuhkannya. Semakin banyak baris komentar yang Anda lihat dalam suatu program, semakin besar kemungkinan program tersebut ditulis dengan buruk. Tentu saja ini bukanlah aturan mutlak.

Komentar penjelasan mungkin berguna bagi mereka yang akan memperbaiki kode di masa mendatang. Misalnya, banyak profesional muda melihat adanya ruang untuk perbaikan di mana pun. Mereka percaya bahwa segala sesuatunya lebih buruk sebelum mereka, dan sekarang saatnya memperbaiki setiap fitur.

Terkadang perasaan serupa juga menimpa para profesional. Misalnya, ketika segala sesuatunya tampak tidak beres, pasti ada solusi yang lebih baik. Untuk melindungi pengikut agar tidak mencari sesuatu yang lebih baik, pemrogram dapat meninggalkan catatan seperti ini: #time_spent_here=24h

Setelah kata-kata seperti itu, hanya sedikit orang yang ingin menghabiskan begitu banyak waktu. Jadi, Anda memperingatkan bahwa banyak opsi berbeda telah dicoba. Pada saat yang sama, Anda harus menghindari serangan seperti: #i_hate_this, #try_to_do_better_ass%%le. Dengan cara ini, Anda hanya menunjukkan sikap tidak profesional. Anda tidak boleh berkompromi dengan diri sendiri dan atasan Anda.

Namun mendokumentasikan komentar kode juga bisa menjadi pemberat bagi programmer. Biasanya, ini adalah area besar yang mengalihkan perhatian langsung dari pemrograman. Namun untuk menampilkan kode tanpa komentar, IDE utama memiliki fungsi yang sesuai. PhpStorm seharusnya tidak menjadi pengecualian, tapi sayangnya. Cari fitur tersebut di dokumen pembaruan.

Tandai sebagai elemen fungsional

Meskipun komentar dimaksudkan untuk memberikan klarifikasi dan bantuan dalam pengembangan tim, fitur ini jarang digunakan. Biasanya, tag ditempatkan di tempat yang diinginkan untuk menghentikan eksekusi kode. Bayangkan Anda memiliki PHP yang tertanam dalam HTML. Dan Anda tidak ingin menghapusnya, tetapi hanya ingin melihat seperti apa halaman tersebut tanpanya. Untuk melakukan ini, Anda harus mengikuti sintaks berikut:

JavaScript

…

…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div >

Seperti yang Anda lihat, dengan tindakan sederhana Anda dapat menghentikan eksekusi kode bahkan tanpa melakukan operasi rumit apa pun. Namun nyatanya, ini bukanlah puncak optimasi. Kenyamanan tambahan bagi pengembang disediakan oleh phpStorm IDE itu sendiri. Dengan menggunakan penyorotan dan pintasan keyboard, Anda dapat mengomentari segmen kode yang dipilih tanpa menetapkan tag khusus. Ini bisa dilakukan seperti ini.

Menggunakan metode yang nyaman bagi Anda, pilih sepotong teks (mouse, pintasan).

Tekan kombinasi tombol Ctr + Shift + /

Selain itu, Anda dapat mengomentari baris saat ini. Semuanya sama, hanya saja tanpa Shift.

Keuntungan dari jenis komentar ini adalah cakupan beberapa bahasa secara bersamaan. PHP jarang berdiri sendiri. Dengan cara ini, Anda tidak perlu menandai satu per satu. Lingkungan mendukung beberapa bahasa web lainnya. Cukup pilih sebuah fragmen dan jual kombinasinya - ini adalah kode multibahasa dan diberi komentar. Dengan cara yang sama, itu bisa diaktifkan.

Itu saja untuk kita. Jika Anda belum pernah menggunakan fitur ini sebelumnya, kami menganjurkan Anda untuk memulai. Pintasan membuat pekerjaan lebih cepat dan lebih baik.

JavaScript. Mulai cepat

Pelajari dasar-dasar JavaScript dengan contoh langsung cara membuat aplikasi web.

... hari ini di artikel singkat namun bermanfaat ini kita akan mengetahui bagaimana berbagai kode program dikomentari. Saya tidak akan banyak bicara, karena jika Anda tertarik dengan hal ini, maka Anda sudah menemui permasalahan ini dan memiliki gambaran tentangnya.

Anda telah datang ke tempat yang tepat... tetapi beberapa kata untuk kejelasan dan manfaat dari masalah ini. Anda mungkin pernah melihat bagaimana hal ini dilakukan dengan kode CSS, karena CSS paling menarik bagi banyak pemula, seperti saya.

… Bagus!

Namun perlu diingat bahwa komentar juga digunakan html dan php... Tetapi kebanyakan pemula menjadi bingung pada tahap awal bekerja dengan situs ini dan tidak tahu bagaimana menambahkan penjelasan yang diperlukan untuk diri mereka sendiri. Lagi pula, misalnya, Anda perlu menonaktifkannya untuk beberapa waktu kode html, lalu melanjutkan fungsinya lagi - ini mudah diterapkan jika Anda telah membuat catatan di "margin", tetapi Anda tidak pernah tahu.

Namun yang harus Anda ingat tentang "komentar" secara umum adalah bahwa semuanya sangat bergantung pada file mana yang Anda gunakan secara spesifik, dan oleh karena itu kode aplikasinya berbeda.

Mengomentari kode CSS

a:hover, a:focus ( warna: #D5071E; dekorasi teks: Overline; /*UNDERLINE TOP*/ )

Dengan cara ini Anda memberi diri Anda penjelasan. Atau Anda bahkan dapat mengomentari skrip css ini seperti ini: bungkus saja

/* KODE disini */

/*a:hover, a:focus ( warna: #D5071E; dekorasi teks: garis bawah; /*UNDERLINE DI BAWAH*/ ​​)*/

Saya menarik perhatian Anda pada fakta bahwa Anda dapat mengomentari seluruh siklus kode css dengan cara ini, tapi!! maka Anda harus menghapus komentar yang berulang /*UNDERLINE AT THE BOTTOM*/, atau bermain-main dengan garis miring jika penjelasannya penting))

Kalau tidak, akan ada kesalahan!!

Catatan:

Jika Anda membuka kode sumber halaman - Ctrl+U dan lihat... Anda akan melihat bahwa potongan kode css yang dikomentari ditampilkan dengan sempurna di dokumen yang dihasilkan! ini jika css digunakan (properti disetel) langsung di html

Dan, seperti yang Anda pahami, jika Anda beralih dari kode sumber melalui tautan ke dokumen css dari template aktif Anda, semua komentar dapat diamati dan dipelajari)) jika ada yang membutuhkannya. Tapi ini tidak mungkin)

Kata keterangan bahasa Inggris (kata-kata) akan dapat dibaca. Simbol Rusia - tidak.

Mengomentari kode HTML

File XML dikomentari dengan cara yang sama

Penting: selalu periksa kode yang ditawarkan dalam artikel, setidaknya secara visual) jika tidak, mungkin ada kesalahan.

Kecerobohan sederhana saat memformat dapat memakan waktu, misalnya, kode yang dikomentari di atas sering kali salah: Alih-alih dua tanda hubung pendek, tanda hubung panjang akan muncul:

Untuk informasi anda:

seperti yang disebutkan dalam komentar sebelumnya, hal yang sama berlaku untuk yang dikomentari... kode html ditampilkan di dokumen yang dihasilkan!

Ingatlah hal ini.

Dan inilah satu hal lagi:

Selain fakta bahwa kode yang dikomentari ditampilkan di kode sumber halaman (dan oleh karena itu diproses dalam beberapa hal, meskipun tidak terlihat di halaman!) - lebih baik menghapus beberapa fungsi PHP bersama dengan html dari dokumen aktif.

Misalnya:

akan terlihat di dokumen dan fungsinyaakan melakukan tugasnya dengan luar biasa: yaitu, informasi tidak lagi terlihat di frontend, tetapi di kode sumber akan ditampilkan dengan jelas! dan ini adalah pertanyaan yang tidak ada gunanya ke database: semua ini sepele, tetapi Anda perlu mengetahuinya!

Hal ini dapat dilakukan jika Anda tidak ingin menghapus sepotong kode dari dokumen:

tambahkan sebelum kode html “ekstra” yang diperlukan pada pembukaan... fungsi bawaan ... dan penutup?> ...

Singkatnya, inilah yang dapat Anda lakukan jika kodenya besar:

**/ ?>

maka sumbernya akan bersih!

Atau lebih sederhana:

Mari kita beri komentar pada fungsi itu sendiri di dokumen html. Kode sumber dalam kasus pengembangan fungsi ini akan bersih!

cara mengomentari javascript

if (beingShown || ditampilkan) ( // jangan memicu animasi lagi return; ) else ( // terapkan KOMENTAR APA PUN di baris // terapkan KOMENTAR APA PUN di baris // true;

Untuk lebih jelasnya, saya mengambil contoh kode JavaScript ini dari internet, sedikit mengoreksi tanda bacanya. Gak masalah... Yang penting paham prinsipnya...

Seperti yang Anda pahami, garis miring ganda “//” adalah TANDA komentar... SINGLE LINE!

Kode JS lainnya dikomentari seperti php, lebih lanjut di bawah ini:

komentar:

Mengomentari kode PHP

...dan...di sini serupa – garis miring-garis...satu baris.

Namun perhatikan bahwa ini dapat dikomentari seperti kode CSS.

...atau Anda dapat berkomentar seperti ini - versi satu baris, ketika kita menggunakan BUKAN DUA Garis miring, tapi BECAR (hash) sebelum baris komentar:

...Tentu saja, Anda perlu berkomentar dengan hati-hati di loop kode!

...atau dengan cara ini - mirip dengan contoh yang ditunjukkan di atas untuk CSS... yaitu. opsi komentar /* code */ ini cocok untuk kode CSS dan JS!

Namun dengan cara ini Anda dapat mengomentari penjelasan kode PHP yang lebih banyak, di antara contoh utamanya...

Anda juga dapat berkomentar di loop PHP dengan cara ini, jika kodenya tercampur... php dan entah bagaimana html

Sama seperti dijelaskan di atas:

Misalnya, beberapa fungsi seperti itu... di suatu tempat di kode umum (atau loop di html):— Anda dapat mengomentarinya, yaitu menambahkan label Anda sendiri seperti ini:

atau seperti ini: opsi satu baris...

Intelijen:

kode php tidak terlihat di kode sumber apa pun!! Hanya hasil fungsionalnya yang terlihat - berhasil!

Pada dasarnya hanya itu yang ingin saya laporkan hari ini!

Sekarang Anda bisa bereksperimen... Semoga berhasil.

Dan tentu saja, baca artikel di situs ini dan berlangganan:
Saya berbagi pengalaman pahit saya - sedikit pengetahuan, untuk kesejahteraan manis Anda))

...kota master web Mihalika.ru© - dengan mudah dengan WordPress

Komentar di PHP mirip dengan komentar yang digunakan di HTML. Dalam sintaksis PHP, komentar selalu dimulai dengan rangkaian karakter khusus dan semua teks yang muncul di antara karakter khusus tersebut akan diabaikan oleh penerjemah.

Dalam HTML, tujuan utama komentar adalah sebagai catatan bagi pengembang yang mungkin melihat kode sumber situs Anda. Komentar PHP berbeda karena tidak akan ditampilkan kepada pengunjung. Satu-satunya cara untuk melihat komentar PHP adalah dengan membuka file untuk diedit. Hal ini membuat komentar PHP hanya berguna bagi programmer PHP.

Jika Anda lupa atau tidak tahu cara membuat komentar dalam HTML, lihat contoh di bawah ini.

Sintaks komentar PHP: komentar satu baris

Meskipun html hanya memiliki satu jenis komentar, PHP memiliki dua jenis. Tipe pertama yang akan kita bahas adalah komentar satu baris. Artinya, komentar yang memberitahu penerjemah untuk mengabaikan segala sesuatu yang terjadi pada baris di sebelah kanan komentar. Untuk menggunakan komentar ini, gunakan karakter "//" atau "#" dan semua teks di sebelah kanan akan diabaikan oleh penerjemah PHP.

Psst...Anda tidak dapat melihat komentar PHP saya!"; // gema "tidak ada"; // echo "Nama saya Humperdinkle!"; # echo "Saya juga tidak melakukan apa-apa"; ?>

Hasil:

Halo Dunia! Psst...Anda tidak dapat melihat komentar PHP saya!

Perhatikan bahwa beberapa perintah echo kami tidak diproses karena kami mengomentarinya menggunakan karakter komentar khusus. Jenis komentar ini sering digunakan untuk menulis kode yang rumit dan membingungkan dengan cepat, atau untuk menghapus sementara sebaris kode PHP (untuk debugging).

Sintaks komentar PHP: komentar multiline

Seperti komentar HTML, komentar multiline di PHP dapat digunakan untuk mengomentari blok kode yang besar atau untuk menulis komentar pada beberapa baris. Komentar multiline di PHP dimulai dengan "/*" dan diakhiri dengan "*/". Apa pun di antara karakter ini akan diabaikan.

Hasil.

Dalam pelajaran ini saya akan berbicara tentang cara membuatnya komentar dalam HTML, CSS, PHP. Komentar adalah teks yang tidak terlihat di halaman web. Mereka digunakan untuk berbagai macam penjelasan, pengingat, dan deskripsi untuk webmaster, yang memungkinkan Anda menyusun dokumen. Komentar sangat diperlukan saat men-debug kode, mereka memungkinkan Anda menavigasi markup halaman web dengan cepat dan menemukan blok yang diinginkan. Komentar sering digunakan untuk men-debug kode HTML. Misalnya, Anda dapat mengomentari sementara blok kode tertentu agar tidak dieksekusi, dan jika perlu, Anda dapat memulihkannya dengan mudah.

Komentar dalam HTML

Dalam HTML, komentar dibentuk menggunakan karakter berikut:. Jadi, teks apa pun di antara karakter-karakter ini adalah komentar. Mari kita lihat sebuah contoh:

Contoh komentar dalam HTML

Komentar di CSS

Komentar di CSS dibuat menggunakan karakter: /* dan */. Untuk membuat komentar, Anda hanya perlu menempatkan kode halaman web di antara karakter berikut:

/* Awal blok dengan gaya untuk Tubuh*/ tubuh ( latar belakang: #efeded; font-family: Verdana, Helvetica, sans-serif; ukuran font: 12px; margin: 0px; padding: 0px; ) /* Akhir dari blok dengan gaya untuk Tubuh*/

Komentar dalam PHP

Komentar di PHP bisa berupa satu baris atau banyak baris:

1) Komentar satu baris di PHP dibuat menggunakan karakter: //. Sederhananya karakter ini di depan baris dan akan dikomentari Opsi ini digunakan jika komentar hanya terdiri dari satu baris.

2) Untuk mengimplementasikan komentar multi-baris, digunakan simbol berikut: /* dan */. Opsi ini berguna jika komentar mencakup beberapa baris.

Jadi kami belajar melakukannya