Drupal Coding Standards

Όταν προγραμματίζουμε, θα πρέπει να τηρούμε τα Drupal Coding Standards, ώστε ο κώδικάς μας να είναι ευανάγνωστος και να μην είμαστε μόνο επαγγελματίες, αλλά και να φαινόμαστε :)

Πριν ξεκινήσουμε λοιπόν, ας δούμε τι πρέπει να προσέχουμε:

1. Εσοχές και κενά διαστήματα

• Χρησιμοποιούμε εσοχή δύο διαστημάτων από επίπεδο σε επίπεδο, χωρίς tabs.
• Οι γραμμές δεν πρέπει να έχουν κενό διάστημα στο τέλος τους.
• Τα αρχεία θα πρέπει να έχουν το \n σαν τέλος γραμμής, όπως στο Unix.
• Όλα τα αρχεία κειμένου θα πρέπει να τελειώνουν με μια απλή αλλαγή γραμμής, έτσι ώστε, αν προστεθεί κάτι στο τέλος, να ξεχωρίζει.
• Όλα τα blocks στην αρχή ενός αρχείου PHP πρέπει να διαχωρίζονται με μία κενή γραμμή. Όπως για παράδειγμα στην παρακάτω εικόνα:

 Ή αν δεν υπάρχει κλάση, όπως στην παρακάτω εικόνα, για αρχεία .module για παράδειγμα. Βλέπουμε πώς ξεχωρίζουν, οι περιοχές namespace, use, με τον υπόλοιπο κώδικα.

 

2. Τελεστές

• Όλοι οι τελεστές που μπαίνουν ανάμεσα σε δύο τιμές, όπως +, -, =, !=, ==, >, κλπ, πρέπει να έχουν ένα κενό πριν και ένα κενό μετά τον τελεστή, για να είναι πιο ευανάγνωστος ο κώδικας. Για παράδειγμα $foo = $bar;
• Τελεστές που μπαίνουν σε μία μόνο τιμή, όπως $n++; ΔΕΝ πρέπει να έχουν κενό ανάμεσα σ' αυτούς και τη μεταβλητή.
• Ο τελεστής του διαφορετικού πρέπει να είναι ο != και όχι ο <>

 

3. Δηλώσεις Τύπου Μεταβλητής

• Προσθέστε ένα κενό ανάμεσα στον τύπο της και τη μεταβλητή, σε μία δήλωση. Για παράδειγμα: (int) $mynumber 

 

4. Δομές Ελέγχου

Είναι οι δομές επιλογής και επανάληψης, όπως η if, η while, κλπ.

Ας δούμε ένα παράδειγμα:

• Ποτέ δεν βάζουμε κενό στο else if. Πάντα χρησιμοποιούμε elseif.
• Θα πρέπει πάντα μετά την εντολή και πριν την παρένθεση της συνθήκης να εισάγουμε ένα κενό, για να ξεχωρίζει από τη σύνταξη μίας συνάρτησης (όπου μέσα στην παρένθεση εισάγονται τα ορίσματα).
• Πάντα χρησιμοποιούμε τα άγκιστρα. Ανοίγουμε στην γραμμή της εντολής μετά από ένα κενό και κλείνουμε στην αρχή της γραμμής με εσοχή ίδια με αυτή που ανοίξαμε.

Παράδειγμα με τη switch:

Παράδειγμα Do - While:

 

5. Εναλλακτική σύνταξη των δομών ελέγχου στα Templates

Όταν γράφουμε κώδικα στα Templates, χρησιμοποιούμε εντολές PHP και HTML, όπως στο παρακάτω παράδειγμα:

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

 

6. Μήκος γραμμής και αναδίπλωση

• Γενικά όλες οι γραμμές δεν πρέπει να ξεπερνούν τους 80 χαρακτήρες.
• Αν υπάρχουν γραμμές που περιέχουν μεγάλα ονόματα συναρτήσεων μπορούν να ξεπερνούν τους 80 χαρακτήρες.
• Οι γραμμές που περιέχουν συνθήκες στις δομές ελέγχου, μπορούν να ξεπερνούν τους 80 χαρακτήρες, αρκεί ο κώδικας να είναι ευανάγνωστος και η συνθήκη κατανοητή.
• Όπως για παράδειγμα:

Οι συνθήκες δεν θα πρέπει να αναδιπλώνονται σε πολλαπλές γραμμές, ούτε να είναι τεράστιες και να περιλαμβάνουν τα πάντα. Μπορούμε να τις σπάζουμε, ώστε να μπορούμε και να εισάγουμε και σχόλια για να τις εξηγούμε:

Εδώ έχουμε αντιστοιχίσει σε λογικές μεταβλητές τις συνθήκες που θέλουμε να ισχύουν, οπότε τελικά έχουμε να ελέγξουμε την τιμή των λογικών αυτών μεταβλητών και ο κώδικάς μας είναι πιο ευανάγνωστος, από ό,τι στην παρακάτω εικόνα:

 

7. Κλήσεις Συναρτήσεων

• Προσοχή στα κενά στις κλήσεις των συναρτήσεων: 

$var = foo($bar, $baz, $quux);

• Δεν υπάρχει κενό ανάμεσα στο όνομα της συνάρτησης, την παρένθεση και το πρώτο όρισμα.
• Μετά το κόμμα, ανάμεσα στα ορίσματα υπάρχει κενό.

 

8. Δηλώσεις Συναρτήσεων

Παράδειγμα:

Αν η συνάρτηση είναι ανώνυμη, πρέπει να αφήσουμε ένα κενό ανάμεσα στη λέξη function και στο όρισμά της. Για παράδειγμα:

 

9. Κλήσεις Constructors Κλάσεων

• Θα πρέπει να βάζουμε πάντα παρενθέσεις στην κλήση των Constructors, ακόμα και αν δεν υπάρχουν ορίσματα, όπως στο παρακάτω παράδειγμα:

$foo = new MyClassName();

• Έτσι θα υπάρχει συνέπεια και ομοιομορφία, με τις περιπτώσεις που υπάρχουν ορίσματα:

$foo = new MyClassName($arg1, $arg2);

 

10. Arrays

• Αν το array είναι μικρό, συντάσσουμε όπως στο παρακάτω παράδειγμα:

• Υπάρχουν κενά μετά το κόμμα, ανάμεσα στα στοιχεία. Υπάρχουν επίσης κενά πριν και μετά τον τελεστή συσχέτισης =>
• Αν το array είναι μεγάλο, κατεβάζουμε κάθε στοιχείο στη δικιά του γραμμή, όπως στο παρακάτω παράδειγμα:

• Προσέξτε το κόμμα που υπάρχει μετά και το τελευταίο στοιχείο του array σε αυτή την περίπτωση.