Οδηγίες Κωδικοποίησης Moodle

Γενικοί Κανόνες

  1. Όλα τα αρχεία πρέπει να χρησιμοποιούν την κατάληξη .php.
  2. Όλες οι γνωστοποιήσεις copyright πρέπει να διατηρηθούν. Αν χρειαστεί μπορείς να προσθέσεις και τη δική σου.
  3. Κάθε αρχείο πρέπει να περιλαμβάνει το κυρίως αρχείο config.php.
  4. Κάθε αρχείο πρέπει να ελέγχει αν ο χρήστης ταυτοποιείται σωστά, χρησιμοποιώντας require_login() και isadmin(), isteacher(), iscreator() ή isstudent().
    1. Όλες οι προσβάσεις στις βάσεις δεδομένων πρέπει να χρησιμοποιούν τις συναρτήσεις στο lib/datalib.php όπου είναι δυνατό - αυτό επιτρέπει συμβατότητα ανάμεσα σε πολλές βάσεις δεδομένων. Θα διαπιστώσεις ότι σχεδόν όλα είναι πιθανά χρησιμοποιώντας αυτές τις συναρτήσεις. Οποιεσδήποτε άλλες δηλώσεις SQL θα πρέπει να είναι : cross-platform; περιορισμένες σε συγκεκριμένες συναρτήσεις μέσα στον κώδικά σου (συνήθως ένα αρχείο a lib.php ) και καθαρά μαρκαρισμένες.
  5. Όλες οι συμβολοσειρές πρέπει να είναι μεταφράσιμες - δημιούργησε νέα κείμενα στα αρχεία "lang/en" και ονόμασέ τα χρησιμοποιώντας get_string() ή print_string().
  6. Όλα τα αρχεία βοήθειας πρέπει να είναι μεταφράσιμα - δημιούργησε νέα κείμενα στον κατάλογο "en/help" και ονόμασέ τα χρησιμοποιώντας helpbutton().

 

Στυλ Κωδικοποίησης

  1. Μη χρησιμοποιείς καθόλου tab. Χρησιμοποίησε 4 κενά για μια συνεχόμενη εσοχή.
  2. Τα άγκιστρα πρέπει πάντα να χρησιμοποιούνται σε έναν κώδικα (ακόμα κι αν είναι της μιας γραμμής). Το Moodle χρησιμοποιεί αυτό το στυλ:

    if ($quiz->attempts) {
        if (
    $numattempts > $quiz->attempts) {
            
    error($strtoomanyattempts, "view.php?id=$cm->id");
        }
    }

  3. Αυτό το έγγραφο δεν έχει τελειώσει ακόμα!

 


Moodle Documentation

Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28 moodler Exp $