Προγραμματισμός ΙΙ: Κανόνες μορφοποίησης

Προγραμματισμός ΙΙ

Κανόνες μορφοποιήσης

Καλογραμμένος Κώδικας

Παράδειγμα(1)

public class Queller{
public static int getDispetal(int cobber,int whinnock){
int result=0;
if(cobber==whinnock)
result=cobber-whinnock;
result++;
else result = cobber*whinnock;
return result;}
public static int getGoverness(int mesodesma,int natrium,int stewardry){
int res = 0;
int haulabout=natrium+(1-mesodesma);
if ((haulabout*haulabout)==stewardry)
res=haulabout;
else res=4*haulabout;
return res;}}

Καλές Πρακτικές

Συμβάσεις Ονομάτων (1)

Συμβάσεις Ονομάτων (2)

Σύμβολο Κανόνας Παράδειγμα
Μεταβλητές σύντομα ονόματα, μικρό αρχικό γράμμα, camelCase wageByYear foundName isEmpty
Σταθερές κεφαλαία γράμματα, underscore στο διαχωρισμό των λέξεων MIN_PER_HOUR

Συμβάσεις Ονομάτων (3)

Σύμβολο Κανόνας Παράδειγμα
Μέθοδοι χρήση ρήματος που δηλώνει τι κάνει η μέθοδος, μικρό αρχικό γράμμα, camelCase draw() calculateSum()
Κλάσεις χρήση ουσιαστικού που δηλώνει τι αντιπροσωπεύει η κλάση, κεφαλαίο αρχικό γράμμα, CamelCase Office, PhoneBook

Παράδειγμα

Να γραφτεί πρόγραμμα που να δέχεται σαν όρισμα ένα πίνακα πραγματικών αριθμών που έχει θερμοκρασίες σε Farenheit για κάθε μήνα του έτους, να υπολογίζει το μέσω όρο όλου του χρόνου και αν η θερμοκρασία σε Celsius ειναι κάτω απο 0 να επιστρέφει "cold", αλλίως να επιστρέφει "warm". (Δε χρειάζεται έλεγχος για την εγκυρότητα του ορίσματος) 
    public static String foo(double[] a) {
        double t = 0;
        for (int i = 0; i < 12; i++) {
        t = t + a[i];}
        t=t/12;
        t = ((t-32)*5)/9;
        if (t < 0) {return "cold";}
        else {
        return "warm";
        }
    }
    private static final double TEMPERATURE_THRESHOLD = 0.0;
    private static final int NUMBER_OF_MONTHS = 12;
    private static final String COLD = "cold";
    private static final String WARM = "warm";

    public static String findAnnualWeatherCondition(double[] monthlyTemperaturesInFarenheit) {
        double meanTemperature = getMeanTemperatures(monthlyTemperaturesInFarenheit);
        double meanInCelsius = convertFarenheitToCelsius(meanTemperature);
        return weatherLabelRelativeToTemperature(meanInCelsius);
    }

    private static double getMeanTemperatures(double[] monthlyTemperaturesInFarenheit) {
        double sumTemperatures = 0;
        for (int i = 0; i < 12; i++) {
            sumTemperatures = sumTemperatures + monthlyTemperaturesInFarenheit[i];
        }
        return sumTemperatures/NUMBER_OF_MONTHS;
    }

    private static double convertFarenheitToCelsius(double farenheitTemperature) {
        return ((farenheitTemperature - 32)*5)/9;
    }

    private static String weatherLabelRelativeToTemperature(double temperature) {
        if (temperature < TEMPERATURE_THRESHOLD) {
            return COLD;
        } else {
            return WARM;
        }
    }

Σχόλια (1)

Σχόλια (2)

Σχόλια (3)

Είδη Κανόνας Συνήθης Χρήση Παράδειγμα
Σχόλια γραμμής ξεκινούν με // σε μεταβλητές, σύντομες μέθοδοι (get/set) //why use this variable
Σχόλια σε block ξεκινούν με /* και τελειώνουν με */ ενώ στις ενδιάμεσες γραμμές βάζουμε μόνο * σε ροές ελέγχου, μεθόδους /* Here is an * example of * how to use this. */ |

Σχόλια (4)

Είδη Κανόνας Συνήθης Χρήση Παράδειγμα
Σχόλια Javadoc ξεκινούν με /** και τελειώνουν σε */ ενώ στις ενδιάμεσες γραμμές βάζουμε μόνο * στην τεκμηρίωση κλάσεων, μεθόδων, και διεπαφών http://www.oracle.com/ technetwork/articles/java /index-137868.html

Doc Comments

/**
 * Returns an Image object that can then be painted on the screen.
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument.
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */

 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

http://www.oracle.com/technetwork/articles/java/index-137868.html

Κατανόηση Κώδικα (1)

    public class Nesting {
        //main method
        public static void main(String[] args) {
            boolean nesting = true;
            int x = 10;
            if (x == 10) {
                int y = 20;
                System.out.println("x and y: " + x +y);
                x = y * 2;
            }
            int y = 100;
            System.out.println("x is: " + x);
            /*
            System.out.println(nesting);
            */ //?
        }
    }

Κενά (1)

Κενά (2)

Εσοχές (Indentation)

Κατανόηση Κώδικα (2)

    public class Queller {

        public static int getDispetal(int cobber, int whinnock) {
            int result = 0;
            if (cobber == whinnock) {
                result = cobber - whinnock;
                result++;
            } else {
                result = cobber * whinnock;
            }
            return result;
        }

        public static int getGoverness(int mesodesma, int natrium, int stewardry) {
            int res = 0;
            int haulabout = natrium + (1 - mesodesma);
            if ((haulabout * haulabout) == stewardry) {
                res = haulabout;
            } else {
                res = 4 * haulabout;
            }
            return res;
            }
    }

Προσομοίωση ρίψης ζαριών

Γράψτε ένα πρόγραμμα που προσομοιώνει τη ρίψη ενός ζεύγους ζαριών. Εκτελέστε το πείραμα μέχρι και τα 2 ζάρια να φέρουν 1 και στο τέλος να επιστρέφει πόσες ρίψεις χρειάστηκαν.
Γράψτε ένα πρόγραμμα που να καλεί και να τρέχει το προηγούμενο πρόγραμμα n φορές και να επιστρέφει το μέσο όρο των φορών που χρειάστηκε να γίνουν οι ρίψεις των ζαριών ώστε να έχουν και τα δύο ζάρια 1.

Εκτύπωση πίνακα διαγώνια

Υλοποιείστε ένα πίνακα που να έχει 10 θέσεις και να λαμβάνει 10 αριθμούς από το 1 μέχρι και το 10. Στην συνέχεια υλοποιείστε μια συνάρτηση η οποία θα μπορεί να μεταφέρει όλα τα στοιχεία από αριστερά προς τα δεξιά, δλδ το πρώτο στοιχείο να το μεταφέρει στην θέση του δεύτερου, το δεύτερο στην θέση του τρίτου κ.τ.λ. Στο τέλος πρέπει να έχετε το ακόλουθο αποτέλεσμα:
[10,1,2,3,4,5,6,7,8,9]
[9,10,1,2,3,4,5,6,7,8]
. . . . . . .
[2,3,4,5,6,7,8,9,10,1]
[1,2,3,4,5,6,7,8,9,10]

Βιβλιογραφία

Creative Commons Licence
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.