Πώς να γράψετε τον καθαρό κώδικα στο C ++

Καθαρισμός κώδικα κώδικα

Κατά την κωδικοποίηση, το στυλ κωδικοποίησης που ακολουθείτε μπορεί να είναι πολύ σημαντικό. Ειδικά όταν εργάζεστε με μια ομάδα ή σκοπεύετε να μοιραστείτε τον κωδικό σας.

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

Να θυμάστε ότι αυτές είναι μόνο προτάσεις για την επίτευξη σαφήνειας, οι οποίες μπορεί να αποτελούν προσωπική προτίμηση. Λάβετε λοιπόν υπόψη αυτές τις συμβουλές, αλλά μην τις λάβετε στην επιστολή. Μερικές φορές η παραβίαση ορισμένων από αυτούς τους κανόνες μπορεί να οδηγήσει σε καθαρότερο κώδικα.

Χρησιμοποιήστε καλά ονόματα μεταβλητών και κάντε σχόλια

Βεβαιωθείτε ότι έχετε δημιουργήσει καλά ονόματα μεταβλητών. Για παράδειγμα, εάν δημιουργείτε ένα παιχνίδι, αποφύγετε τη χρήση της μεταβλητής "a" και αντ 'αυτού χρησιμοποιήστε κάτι σαν "p1" όταν αναφέρεστε στον παίκτη 1.

Ο ουγγρικός συμβολισμός χρησιμοποιείται συνήθως και μπορεί να σας δώσει μερικές οδηγίες για τη δήλωση μεταβλητών.

Επίσης, ΠΑΡΑΚΑΛΟΥΜΕ, χρησιμοποιήστε σχόλια. Μην αστειεύεστε, απλώς προσπαθήστε να διαβάσετε μερικά παλιά έργα που κάνατε χωρίς σχόλια… τώρα φανταστείτε να είστε κάποιος άλλος που δεν τον κωδικοποίησε καν.

Καθολικές μεταβλητές

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

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

#include  using namespace std; // Global variables are declared outside functions int cucumber; // global variable "cucumber"

Χρησιμοποιώντας το goto, συνεχίστε κ.λπ.

Αυτή είναι μια κοινή συζήτηση μεταξύ των προγραμματιστών. Ακριβώς όπως οι καθολικές μεταβλητές, αυτοί οι τύποι δηλώσεων θεωρούνται συνήθως κακές πρακτικές. Θεωρούνται κακές επειδή οδηγούν σε «κώδικα spaguetti».

Όταν προγραμματίζουμε θέλουμε μια γραμμική ροή. Αλλά όταν χρησιμοποιείτε αυτές τις δηλώσεις, η ροή τροποποιείται και οδηγεί σε μια "συνεστραμμένη και μπερδεμένη" ροή.

Το Goto χρησιμοποιήθηκε στο παρελθόν. Αλλά όταν, ενώ, για, αν οι λειτουργίες ήρθαν, ωστόσο, με την εισαγωγή αυτών των δομημένου προγραμματισμού δημιουργήθηκε. Σε γενικές γραμμές, αποφύγετε τη χρήση του goto, εκτός εάν είστε βέβαιοι ότι θα κάνει τον κώδικα σας πιο καθαρό και πιο εύκολο να το διαβάσετε. Ένα παράδειγμα μπορεί να το χρησιμοποιεί σε ένθετους βρόχους.

Η χρήση διακοπής και συνέχισης είναι σχεδόν η ίδια. Χρησιμοποιήστε τα σε διακόπτες και προσπαθήστε να κάνετε λειτουργίες με έναν σκοπό, ώστε να έχετε μόνο ένα σημείο εξόδου.

π.χ.

Αποφύγετε την αλλαγή της μεταβλητής ελέγχου στο εσωτερικό ενός βρόχου για

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

int i=1; while (i <= 5) { if (i == 2) i = 4; ++i; }

Αντί:

for (int i = 1; i <= 5; i++) { if (i == 2) { i = 4; } // Do work }

Δηλώστε σταθερές και τύπους στην κορυφή

Συνήθως δηλώνονται μετά από βιβλιοθήκες. Αυτό τα ομαδοποιεί και τα καθιστά ευκολότερα στην ανάγνωση. Για τοπικές μεταβλητές είναι το ίδιο: δηλώστε τις στην κορυφή (Οι άλλοι προτιμούν να τις δηλώνουν όσο το δυνατόν πιο αργά για να εξοικονομήσουν μνήμη δείτε: cplusplus.com).

Χρησιμοποιήστε μόνο μία λειτουργία επιστροφής στο τέλος

Όπως είπα και πριν, τείνω να κάνω μόνο μία είσοδο και έξοδο για να κάνω τη ροή πιο καθαρή.

Χρησιμοποιήστε σγουρά τιράντες ακόμα και όταν γράφετε ένα μονόκλινο

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

Αντί:

for (int i = 1; i <= 5; i++) //CODE

Κάνε αυτό:

for (int i = 1; i <= 5; i++) { //CODE }

Άλλες συστάσεις

Χρησιμοποιήστε forόταν γνωρίζετε τον αριθμό των επαναλήψεων, αλλά χρησιμοποιήστε whileκαι do whileόταν δεν το γνωρίζετε.

Χρησιμοποιήστε const, περάστε με τιμή / αναφορά όταν είναι κατάλληλο. Αυτό θα βοηθήσει στην εξοικονόμηση μνήμης.

Γράψτε const σε κεφαλαία, τύπους δεδομένων ξεκινώντας με T και μεταβλητές με πεζά γράμματα.

const int MAX= 100; //Constant typedef int TVector[MAX]; //Data type TVector vector; //Vector