Σχόλια PHP, Include/Include_once, Require/Require_once

Γιατί να χρησιμοποιήσετε τα σχόλια;

• Αν δεν εργαστείτε στον πηγαίο κώδικα για κάποιο χρονικό διάστημα, είναι εύκολο να ξεχάσετε τι κάνει. Σχολιάζοντας τον πηγαίο κώδικα, θα θυμάστε τι κάνει.
• Ο σχολιασμός του πηγαίου κώδικα είναι επίσης πολύ σημαντικός όταν πολλοί προγραμματιστές πρέπει να εργαστούν στο ίδιο έργο. Οι αλλαγές που γίνονται από έναν προγραμματιστή μπορούν εύκολα να γίνουν κατανοητές από άλλους προγραμματιστές διαβάζοντας απλά τα σχόλια.
• Ως βέλτιστη πρακτική, θα πρέπει να έχετε 3 γραμμές σχολίων για κάθε 10 γραμμές κώδικα.

Σχόλια PHP

• Τα σχόλια μας βοηθούν να κατανοήσουμε τον κώδικα
• Τα σχόλια είναι επεξηγήσεις που περιλαμβάνουμε στον πηγαίο κώδικα μας. Αυτά τα σχόλια είναι για την ανθρώπινη κατανόηση.
• Τα σχόλια μίας γραμμής ξεκινούν με διπλές καθέτους // και τελειώνουν στην ίδια γραμμή.
• 
• Τα σχόλια πολλαπλών γραμμών ξεκινούν με κάθετο προς τα εμπρός ακολουθούμενο από τον αστερίσκο /* και τελειώνουν με τον αστερίσκο ακολουθούμενο από την κάθετο προς τα εμπρός */.
• 

Το παρακάτω διάγραμμα δείχνει ένα αρχείο PHP με σχόλια τόσο σε πολλαπλές γραμμές όσο και σε μία γραμμή.

Παράδειγμα PHP

PHP Include & PHP Include_once

Η πρόταση PHP "include" χρησιμοποιείται για την συμπερίληψη άλλων αρχείων σε ένα αρχείο PHP.

Έχει δύο παραλλαγές, include και include_once. Η συνάρτηση include_once αγνοείται από τον διερμηνέα PHP εάν το αρχείο που πρόκειται να συμπεριληφθεί έχει ήδη συμπεριληφθεί.

Η δήλωση include έχει την ακόλουθη σύνταξη

<?php
include 'file_name';
?>

Η δήλωση include_once έχει την ακόλουθη σύνταξη

<?php
include_once 'file_name';
?>

ΕΔΩ,

• Η εντολή “include/include_once” είναι η εντολή που περιλαμβάνει το αρχείο.
• Το «'file_name'» είναι το όνομα του αρχείου που θα συμπεριληφθεί.

Παράδειγμα: Συμπερίληψη / Συμπερίληψη_μία φορά

Ας υποθέσουμε ότι είστε αναπτυγμένοιping ένας ιστότοπος που περιέχει το ίδιο μενού πλοήγησης σε όλες τις σελίδες.

Μπορείτε να δημιουργήσετε μια κοινή κεφαλίδα και στη συνέχεια να την συμπεριλάβετε σε κάθε σελίδα χρησιμοποιώντας την εντολή include. Ας δούμε πώς μπορεί να γίνει αυτό.

• Θα δημιουργήσουμε 2 αρχεία με το όνομα
• header.php, index.php

Παρακάτω είναι ο κώδικας για header.php

<a href="index.php">Home</a>

<a href="aboutus.php">About us</a>

<a href="services.php">Services</a>

<a href="contactus.php">Contact Us</a>

index.php

<?php

include 'header.php';

?>

Η σελίδα κεφαλίδας παραπάνω θα εμφανίσει τους συνδέσμους πλοήγησης.

PHP Require & PHP require_once

Η εντολή require έχει δύο παραλλαγές, require και require_once.

Η εντολή require/require_once χρησιμοποιείται για την συμπερίληψη ενός αρχείου.

Η συνάρτηση require_once αγνοείται εάν το απαιτούμενο αρχείο έχει ήδη προστεθεί από οποιαδήποτε από τις τέσσερις εντολές include.

Έχει την εξής σύνταξη

<?php
require 'file_name';
?>

<?php
require_once 'file_name';
?>

ΕΔΩ,

• Το “require/require_once” είναι η πρόταση που περιλαμβάνει το αρχείο
• Το «'file_name'» είναι το όνομα του αρχείου που θα συμπεριληφθεί.

Παράδειγμα: Απαιτείται

Ας υποθέσουμε ότι είμαστε σε ανάπτυξηping μια εφαρμογή που τροφοδοτείται από βάση δεδομένων.

Μπορούμε να δημιουργήσουμε ένα αρχείο ρύθμισης παραμέτρων που μπορούμε να συμπεριλάβουμε σε όλες τις σελίδες που συνδέονται με τη βάση δεδομένων χρησιμοποιώντας τη δήλωση ζήτησης. config.php

<?php

$config['host'] = 'localhost';

$config['db'] = 'my_database';

$config['uid'] = 'root';

$config['password'] = '';

?>

Ας δούμε τώρα το δείγμα κώδικα που απαιτεί το αρχείο ρυθμίσεων. Pages_model.php

<?php

require 'config.php'; //require the config file

//other code for connecting to the database

?>

PHP περιλαμβάνει vs απαιτούν

Η διαφορά μεταξύ των εντολών include και require φαίνεται παρακάτω.

Γενικά, συνιστάται η χρήση της πρότασης include, έτσι ώστε όταν παρουσιαστεί κάποιο σφάλμα, η εκτέλεση του σεναρίου να συνεχίσει να εμφανίζει τη διεύθυνση email του webmaster ή τη σελίδα επικοινωνίας.

Η δήλωση ζήτησης θα πρέπει να χρησιμοποιείται εάν ολόκληρο το σενάριο δεν μπορεί να εκτελεστεί χωρίς το ζητούμενο αρχείο.

Οι εντολές "include" και "require" μπορούν να χρησιμοποιηθούν σε οποιαδήποτε γραμμή του πηγαίου κώδικα όπου θέλετε να εμφανίζεται ο κώδικας.

Σχόλια τεκμηρίωσης PHP (PHPDoc)

Πέρα από τα σχόλια μίας και πολλαπλών γραμμών, οι προγραμματιστές PHP χρησιμοποιούν σχόλια μπλοκ PHPDoc για την τεκμηρίωση συναρτήσεων και κλάσεων. Ένα μπλοκ PHPDoc ξεκινά με /** και χρησιμοποιεί ετικέτες όπως @param και @return που διαβάζουν τα IDE για να εμφανίσουν υποδείξεις και αυτόματη συμπλήρωση.

<?php
/**
 * Adds two numbers together.
 *
 * @param int $a The first number
 * @param int $b The second number
 * @return int The sum of the two numbers
 */
function add($a, $b) {
    return $a + $b;
}
?>

Το PHPDoc δεν αλλάζει τον τρόπο εκτέλεσης του κώδικα, αλλά καθιστά σαφή την πρόθεση κάθε συνάρτησης και επιτρέπει στα εργαλεία να δημιουργούν αυτόματα τεκμηρίωση API. Η προσθήκη του σε κοινόχρηστα αρχεία, όπως τα αρχεία διαμόρφωσης και βοήθειας που αναφέρονται παραπάνω, διατηρεί τη βάση κώδικα σε θέση να διατηρηθεί.

Συχνές Ερωτήσεις