τα σχόλια δεν είναι περιττά

Posted by Ελένη Γεωργίου Thu, 10 Aug 2006 17:25:25 EEST

Όποιος δε βάζει σχόλια στο κώδικα του, θα έρτει μια μέρα που ΟΛΟΙ οι συνάδελφοι του θα την κάνουν νωρίς από το γραφείο για παρασκευο/σαββ/κυρ/κο/δευτέρα, ενώ ΕΣΥ τεμπέλη αχαίρευτε ΑΣΧΟΛΙΑΣΤΕ προγραμματιστή, πρέπει να χτυπήσεις περίεργες ώρες από πάνω, για να κάνεις τις τελευταίες αλλαγές πριν την παράδοση ΕΝΩ θα μπορούσες να ήσουν φοινικούες τωρά, επειδή αν είχες σχόλια δε θα ήταν ανάγκη να τα καταλάβεις ΟΛΑ από την αρχή.

Εν καλά τωρά που τους βλέπεις όλους έναν έναν να φεύκουν;

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

γαμώτο.

Posted in θυμωμένα, δουλειά | 7 comments

    Reader's Comments

  1. τα σχόλια δεν είναι περιττά, είναι το Α και το Ω!!!!

    -- Ανδρέας Ευθυμίου ~antrikos, August 10, 2006

  2.   Real programmers don't comment their code. If it was hard to write, it should be hard to understand.

    :)

    -- Νεόφυτος Δημητρίου ~k2pts, August 10, 2006

  3. Τα σχόλια στο κώδικα είναι για τα μωρά του δημοτικού.

    Ο καλός κώδικας μιλά μόνος του.

    Με καλύπτει ο Νεόφυτος

    -- Κώστας Αργυρίδης ~rossos, August 10, 2006

  4. Νομίζω τεράστιας σημασία είναι η καλή ονοματολογία. Αν οι ονομασίες είναι αρκετά επεξηγηματικές, πολλές φορές τα σχόλια καθίστανται περιττά. Ας πούμε, αυτό:

        if (iCtrlSt == -1) {
              wErr(fp,"Controller inactive. Cannot continue");
      …

    μάλλον είναι πιο καθαρό αν γραφεί ως:

        if (controllerStatus == -1) {
              WriteErrorInLogFile(logFilePointer,"Controller inactive. Cannot continue");
      …

    Ίσως μπορούμε να κάνουμε και καλύτερα:

      #define CONTROLLER_INACTIVE  -1

      int IsControllerInactive(void) {
          return controllerStatus == CONTROLLER_INACTIVE;
      }

        if (IsControllerInactive()) {
              writeErrorInLogFile(logFilePointer,"Controller inactive. Cannot continue");
      …

    Στο άλλο ακρό βρίσκονται οι περιπτώσεις όπου τα σχόλια είναι κάμποσα, αλλά άχρηστα. Τι να το κάμω δηλαδή τούτο:

        i++;  // Increase i by 1
        if (isControllerInactive()) exit;  // If controller is inactive, exit.

    -- Χρίστος Ευαγγέλου ~christose, August 10, 2006

  5. Kαληνύχτα, καλά να περάσεις κ καλή ξεκούραση

    -- Ανδρέας Φλωρίδης ~flo, August 10, 2006

  6. χεχε Φλο, απόψε μια χαρα θα ξεκουραστώ, θέκκιου, επειδή ε τ έ λ ε ι ω σ α αααααμήν. Πάντος έχει δίκαιο ο Χρίστος.. καιρός να αρχίσω να γράφω σωστά. Βέβαια, εμένα θα κερδίσει η μικρή μου αδελφή το τζόκερ κ δε θα χρειάζεται να κάμνω το προγραμματιστή για πολλά ακόμα :P Σκέφτομαι να της ζητήσω να μου αγοράσει ένα διώροφο διαμέρισμα κάπου στη Βιέννη κ να μετακομίσω εκεί να ποτίζω τις γλάστρες μου κ να διαβάζω τα βιβλία μου. Αν της υποσχεθώ ότι εν θα της ξαναμιλήσω, μπορεί να μου ανοίξει κ μια μικρή καφετέρια εκεί .. χμ.. οι πιθανότητες είναι ατελείωτες. Προς το παρόν πρέπει να γράφω σχόλια. Είναι που άμα δουλεύκω πάνω σε κάτι μόνη μου, εν δύσκολο να έβρω κίνητρο να το κάμνω συσταρισμένα :P

    -- Ελένη Γεωργίου ~geleni, August 11, 2006

  7. Μετά από συζήτησή με τον πελάτη μου (βλέπε Γεωργία) αποφασίσαμε ότι έννεν ανάγκη να της υποσχεθείς πως εν θα της ξαναμίλήσεις, αρκεί να την ψηφίσεις. Τα έξοδα για το σπίτι στην Βιέννη αναλαμβάνει τα το κόμμα.

    -- Ανδρέας Φλωρίδης ~flo, August 11, 2006