Page 7 of 7
Re: Daily Programming Thread
Posted: Sat Apr 02, 2016 2:01 am
by ThOdOr1s
Έχω έναν προβληματισμό σχετικά με το πόσα notes χρειάζονται μέσα στον κώδικα. Έχω την εντύπωση ότι προσωπικά είμαι λίγο overkill. Έχω παρατηρήσει ότι ειδικά τελευταία, γύρω στο 60% των lines μου είναι notes. Εκτός από το γεγονός ότι μου αρέσει να γράφω τι κάνω σε κάθε γραμμή (αν δεν είναι 100% obvious, ofc). Κάποιες φορές γράφω ολόκληρες παραγράφους και κάνω σηματάκια από text n shit. Όχι για κανέναν άλλο λόγο, αλλά γιατί μου αρέσει - βοηθούν έμενα.
Where does one draw the line? Υπάρχει κάποιο conventional wisdom σχετικά με αυτό?
Re: Daily Programming Thread
Posted: Sat Apr 02, 2016 4:56 am
by pgetsos
Ναι, κοιτα, μαλλον τα σηματακια ξεφευγουν
Απο τη στιγμη που ο κωδικας ειναι για σενα, γραφε οτι θελεις προσωπικα. Αν δουλευεις σε ομαδα, αυτο το μιλας απο πριν
Προσπαθω να "ακολουθω" την λογικη των javadoc σχολιων, μικρη περιγραφη, τι κανουν οι μεταβλητες, τι γυριζει. Ισως και κανα ξεμπαρκο αν καποια γραμμη θελει εξηγηση
Re: Daily Programming Thread
Posted: Sun Apr 03, 2016 2:54 pm
by Spongebobu
Συνήθως η καλή πρακτική είναι να έχεις επεξηγηματικά ονόματα μεταβλητών και μικρές μεθόδους/συναρτήσεις - ως 20 γραμμές το πολύ - ώστε να μην χρειάζεται να βάζεις σχόλια, πέρα από το docstring στην αρχή. Οπότε αν δείς οτι ξεφεύγεις απο το όριο ή οτι η μέθοδος κάνει 2-3 πράματα ταυτόχρονα, καλό θα ήταν να κάνεις ένα refactor.
Τώρα αν γράφεις κώδικα που είναι δύσκολος από τη φύση του (Α.Ι.) ή αν κάνεις hack-ιά που δε συνηθίζεται, μια παραπάνω επεξήγηση δε βλάπτει, απλά μη το παρακάνεις, σε φάση:
Code: Select all
int numOfItems = 10; // The number of items
// Check if there is available space for items
if(numOfItems <= store.availableSpace()) {
// Insert items
store.insertItems("Potato", numOfItems)
}
Αλλά αν, οπως είπε και ο pgetsos, τον κώδικα θα τον βλέπεις μόνο εσύ βάζε και links απο 9gag σε κάθε δεύτερη γραμμή, who cares :P
Re: Daily Programming Thread
Posted: Sat Sep 03, 2016 5:19 pm
by Alive