PHP Yorum Satırları ve Önemi

Merhaba. Şu PHP’nin yorum satırları ilk başta gereksiz gibi dursa da aslında çok önemliler. Bunun önemini yıllar sonra kodları açıp baktığınızda anlıyorsunuz. Güzel hoş şeyden bahsediyorsun da ne gerek var dediğinizi duyar gibiyim.

PHP ‘de Yorum Satırları Neden Kullanılır?

  • Kodları yazarken bazı yerleri vurgulamak için;
  • Kodlara tekrar girip baktığımızda rahat hatırlamak için;
  • Kodlarda düzen oluşturmak ve iyileştirmek için;
  • Kodları başka kişilere açtığınızda onların kodları daha kolay anlamasını sağlamak için;
  • Kodlara copyright ve lisans bilgileri eklemek için;
  • Birde benim gibiler için bazı kodların sonucunu gördükten sonra onları pasifleştirmek için;

kullanabilirsiniz. Bu tamamen size kalmış birşey. Gelin beraber öğrenelim ve kullanalım.

PHP ‘de yorum satırları eklemek için #, // ve çoklu satır için /**/ kullanılır. Basit olarak kullanımlarını açıklayayım.

# ve // ile başlayan satır yorum satırı olur. Bu ifadelerden sonra yazdıklarınız yorum olarak gözükmez direk php kodu gibi algılanır, php onları çalışmak ister ama PHP hata verir. Çünkü; alt satıra geçince bu işaretlerin etkisi sona erer. Bu tür durumda /**/ kullanılır.

/**/ karakterlerinde ise yıldızlar arasına ne kadar yazı yazmak isterseniz yazabilirsiniz. Örneğin;

<?php
/*
system_xxxx.php

Copyright (c) 2018 Netopsiyon
All rights reserved.
*/

Bu satırlar yorumdur. Hiçbir önemi yoktur. Tabii bu şekilde biraz şekilsiz oldu. Az şekil verelim ve lisans bilgisi filanda ekleyelim güzelleşsin.

<?php
/*
* system_xxx.php
*
* Copyright (c) 2018 Netopsiyon
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

Şimdi daha güzel göründü değil mi 🙂 Burası tamamen hayal gücünüze kalmış ancak işin içine TSE, Belgelendirme vb. işlemler girecekse bunu daha düzgün hale getiriyoruz. Nasıl mı? Bakın aşağıya ekledim.

<?php
############################################################
# Proje Adı:
# Oluşturma Tarihi:
# Revizyon Tarihi:
# Revizyon No:
# Hazırlayan:
# Kontrol ve Onaylayan:
# MD5SUM Bilgisi:
# Dosya Adı:
# Kullanım Amacı:
#############################################################

Bunları bu şekilde eklemezseniz belge almak için uğraşırsınız. Bu şablonu TSE için gelen arkadaştan almıştım 🙂 Tabii bunlar yeterli değil, Alpha ve Beta testleri..vb. gibi birçok belge hazırlayıp vermelisiniz. Bu konuda bilgi almak isterseniz marka, patent işleri yapan bir firma ile görüşebilirsiniz. Bu benim konum değil 🙂

Bunlar dosyanın genelde ilk satırlarında yer alacak şeyler.

Yukarıda tarif ederken “Birde benim gibiler için bazı kodların sonucunu gördükten sonra onları pasifleştirmek için” demiştim ya işte bunu açıklayayım.

Bir SQL sorgusu yazdık diyelim. Satırımız şöyle olsun.

$sql="SELECT * FROM lisanslar WHERE kimlikkodu='".$_POST["kimlik"]."' and tarih='".$_POST["tarih"]."'";

Hemen alt satırda SQL olarak yazdığımız doğru mu, POST verileri doğru geliyor mu diye echo ile ekrana yazalım.

$sql="SELECT * FROM lisanslar WHERE kimlikkodu='".$_POST["kimlik"]."' and tarih='".$_POST["tarih"]."'";
echo $sql;

Ekrana yazan kodu phpmyadmin yada mysql workbench ile sorgulayıp durumu görebiliriz. Sonrasında ise echo $sql; yazdığımız yerin başına yorum satırı ekleyelim.

$sql="SELECT * FROM lisanslar WHERE kimlikkodu='".$_POST["kimlik"]."' and tarih='".$_POST["tarih"]."'";
//echo $sql;

Artık SQL sorgumuz ekranda gözükmez. Dosya ile işimiz tamamen bitince etkisiz hale getirdiğimiz satırları bulup silebiliriz. Çünkü yorum satırlarından sonraki bölümler artık çalışmaz. yada /* */ ile yapalım aynısını. Sorgumuz şöyle;

$row=mysqli_fetch_array($sql);
echo "<pre>";
print_r($row);
echo "</pre>";

Ekranı gördük, verilerimiz doğru geliyor. İşimiz bitti. Yorum haline getirerek kodları etkisiz yapalım.

$row=mysqli_fetch_array($sql);
/*
echo "<pre>";
print_r($row);
echo "</pre>";
*/

UNUTMAYALIM: Yorum satırları arasına yazdıklarınız tarayıcılardan sayfayı çağırınca gözükmez.

Herhalde bu kadar yeterli. Sorularınız varsa yorum olarak yazabilirsiniz.

Bir cevap yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir

This site uses Akismet to reduce spam. Learn how your comment data is processed.