[Powered by Google Translate] En aquest vídeo, parlarem d'estil de codi, que és una cosa
que és proper i estimat al meu cor.
Estil descriu com el codi està formatat, la qual cosa és
independent del que el codi fa realment.
No només va a aconseguir un bon estil que una millor qualificació al CS50,
sinó que també l'ajudarà a escriure codi que és molt més
llegible i fàcil de mantenir, que, al final de la dia,
es farà la vida molt més fàcil.
>> Els tres components principals de l'estil de codi que es discutiran
aquest vídeo són els comentaris, el format,
i variables noms.
Anem a començar amb comentaris.
Recordeu, els comentaris no tenen cap efecte sobre la
funcionalitat del codi.
Només serveixen com consells útils per a nosaltres com a programadors.
Bons comentaris han de respondre a una de les dues preguntes.
>> En primer lloc, què significa aquest bloc de codi?
Aquesta és una descripció breu i dolç de la finalitat de
Les línies que segueixen.
Per exemple, pot ser que hagi de trobar el lloc on es
implementat una característica particular de fixar un
bug o alguna cosa pel canvi.
Sense comentaris, pot ser que hagi d'estudiar minuciosament moltes línies de
codi tractant d'esbrinar exactament on aquesta característica és.
O si han passat uns dies des que et va mirar a un
seus programes, és possible que no recordi el que un determinat
funció o bucle fa.
Així farà comentaris familiarizándome de nou a tu mateix amb
Codi d'edat, o donar a conèixer a si mateix amb una altra persona
codi, molt més suau.
La segona pregunta es respon un bon comentari és per què ho vaig fer
implementar aquest bloc d'aquesta manera?
En escriure codi, sovint necessitarà
per prendre decisions de disseny.
Haig de fer servir un bucle while o bucle aquí?
He de fer aquest bloc de codi en una funció separada?
L'ús de comentaris, pot documentar el seu disseny
decisiones, el que farà que el seu codi sigui més fàcil d'entendre
per a altres, que poden estar preguntant exactament el mateix
qüestions de disseny, ja que llegir el codi.
O fins i tot a tu mateix, si tornes a un bloc de codi després de
algun període de temps.
>> En C, i les altres llengües que veurem al CS50, hi ha
dues maneres d'afegir comentaris al seu codi, comentaris en línia
i els comentaris de diverses línies.
Comentaris en línia són excel · lents per documentar peces de codi
dins de les funcions.
Per exemple, un comentari en línia podria descriure la
fi d'un bucle for o un cas extrem que requereix
una condició.
Comentaris de diverses línies són excel · lents per documentar les funcions.
Cada vegada que s'escriu una funció, ha de sempre, sempre,
sempre documentar el que fa amb un comentari.
Això inclou el que les entrades de la funció són, quin és el
sortida de la funció és, i potser per què la funció és
implementat en la forma en què ho és.
Cada vegada que canviï la signatura d'una funció, torni
valor, o l'aplicació, és important actualitzar també la
comentari de documentació corresponent.
La manca de concordança entre els comentaris de la funció i
implementació pot ser molt confús per als lectors.
De la mateixa manera, la creació d'un comentari de diverses línies a la part superior
de cada c. o. arxiu s'escriu h, descrivint el que l'
arxiu és, és també una molt bona idea.
>> A mesura que estàs comentant el seu codi, una de les primeres preguntes que vostè
podria haver és, bé, quant he de comentar el meu codi?
Sovint és necessari documentar cada
sola línia de codi.
Per exemple, una línia que diu int x = 5 no necessita una
comentar sobre el que diu "set x 5".
No comentar prou, tot i que, com hem vist, pot fer
la comprensió del seu codi molt difícil.
Així que una bona regla d'or és per comentar blocs interessants de
codi, on un bloc consisteix en una poques línies relacionades.
>> Així que donem una ullada a un exemple.
Aquí està una funció de C sense comentaris.
D'acord, ja que aquesta és una funció, el primer que hem d'afegir
és un comentari que explica el que les entrades de la funció
és i el que fa.
Així que anem a inserir un comentari de diverses línies.
Gran.
Ara sabem exactament quina és la nostra funció fa.
Anem a afegir alguns comentaris en línia ara.
Podem dividir el nostre codi en dos blocs de línies similars.
Les línies 4 i 5 cordes constructe basat en les aportacions i
línies 6-9 Sortida aquests
cadenes en lletres de cançons.
Així que anem a documentar que amb els seus comentaris.
Awesome.
Ara la nostra funció es comenta.
>> Recordeu que els comentaris en línia no és necessari utilitzar completa
frases o acaben amb un punt.
És important que hi hagi un espai entre la segona barra
i l'inici de l'observació.
Aquesta és la freqüència de les observacions dins dels seus programes
que ha de ser apuntant.
Cal notar aquí com ens separem els dos blocs de codi relacionat
dins la nostra funció cor amb un retorn de carro addicional.
>> Això ens porta al següent component d'estil de codi,
format.
Quan vaig començar a programar, em va colpejar el Enter
clau amb molt poca freqüència, el que va resultar en gegant, il · legible
gotes de codi.
Crec que realment ofès al meu company d'ensenyament, ja que
no estava molt content amb mi.
Visually agrupar blocs de codi relacionada amb el transport
devolucions, pot fer que el seu codi sigui més fàcil descremada i clarament
delinear les línies de codi estan explicant els seus comentaris.
Dit això, estenent el seu codi massa, igual que amb
dues o més línies entre els blocs de codi o funcions, pot
també fan que sigui molt menys llegible.
>> La sagnia és una altra important
aspecte de format de codi.
Sempre, sempre, sempre guió del cos d'una funció, llaç,
o condició.
Això deixa clar que les línies de codi estan dins d'una
bucle, per exemple, i les línies de codi
estan fora d'això.
CS50 recomana guió amb quatre espais, però
si decideix una altra cosa, assegura't de ser coherent
tot el codi.
En aquest sentit, CS50 recomana col · locar claus
en la seva pròpia línia.
D'aquesta manera, els suports s'alinearan visualment a la mateixa esquerra
marge, per la qual cosa és clar com l'aigua, on un bloc comença i acaba.
No obstant això, també és bo per col · locar brackets en la mateixa línia com
condició, per exemple, per conservar espai.
Si ho fa, però, assegureu-vos d'incloure un espai
abans de la clau de tancament pel que no smooshed al costat d'un tancament
parin o una paraula.
>> Qualsevol que triï, el més important és ser
consistent en tot el codi.
El que no volem veure, però, és
sagnia claus.
Si ho fa, fa que els frens semblen desconnectats de la
condició, llaç, o la funció que estan demarcació, per la qual cosa
el codi sigui difícil de llegir.
En C i en els altres idiomes que veurem, les claus són
opcional per les condicions d'una sola línia o bucles.
Està bé per ometre les claus en aquest cas, però si
ho fa, assegureu-vos d'estar d'acord
tot el codi.
>> En la definició de funcions, CS50 recomana escriure el
retornar el tipus de la funció en la mateixa línia que el nom de
la funció.
No obstant això, també és ben escriure el tipus de devolució pel seu compte
línia, la qual cosa pot fer que la definició de funcions fàcils de trobar en
alguns editors de text.
>> Finalment, assegureu-vos d'incloure espais al voltant de
paraules clau i operadors.
Per exemple, una línia que diu int x = 5 és molt més fàcil
llegir si hi ha espais al voltant del signe igual.
De la mateixa manera, assegureu-vos que té un espai abans de paraules com si,
per, i temps.
Sense espai, aquests podrien semblar crides a funcions,
que no ho són.
>> Així que anem a fer una ullada a un exemple de l'aplicació d'un bon estil
a un bloc de codi amb format incorrecte.
Bé, anem a començar des del principi.
Podem veure que la clau d'obertura de la principal està en el mateix
línia com el nom de la funció.
Si fem això, ha d'haver un espai entre
el parèntesi de tancament i clau de la, així.
No obstant això, CS50 recomana que els frens destaquen
en la seva pròpia línia.
Així que farem això.
Ara que estem en el cos de la funció principal, necessitarem
per iniciar sagnia al codi, utilitzarem el
recomanar quatre espais.
A continuació, veiem que no hi ha espai al voltant del signe igual
aquí, així que afegirem això.
Aquí, es veu que no hi ha espai entre el Si i el
obert parèntesi, així que afegirem que, juntament amb l'espai al voltant de
el signe més gran que.
Un cop més, veiem que no hi ha espai entre el parèntesi de tancament i
la clau d'obertura aquí.
Si anem a posar això en la mateixa línia, cal que
ser un espai abans del claudàtor.
No obstant això, sembla que el cos del nostre
condició és només una línia.
Així que no cal incloure les claus en absolut.
Ara hem d'estar segurs de guió en el cos de cada un
les nostres condicions.
Definitivament no vull que aquesta última línia per ser al mateix
línia com els altres, així que prem Enter i guió.
Finalment, la clau de tancament de les principals necessitats per estar en
seva pròpia línia.
>> Podem veure aquí tenim dues diferents
blocs de codi relacionat.
Les línies 4-6 demanarà a l'usuari per a l'entrada i la
les línies restants mostren que l'entrada a l'usuari.
Així que té sentit posar una mica d'espai entre aquests dos blocs
per a major claredat.
I aquí anem, ara el codi és molt més fàcil de llegir amb
bon estil.
>> Finalment, parlarem del nostre tercer component del bon estil:
noms de variables.
Els noms de variables han de descriure el
valor que representen.
Anem a tornar al nostre exemple anterior.
Ampolles és un bon nom descriptiu per a la variable que
representa quantes ampolles es deixen a la paret.
Noms com xo numBots no són molt descriptius i estan
no és bo per a la llegibilitat del codi.
Mentre variables trucades per una sola lletra són comuns en
matemàtiques i altres camps, poden fer que el codi molt dur
d'entendre.
L'excepció a aquesta regla és Iterador
variables dins de bucles.
En els bucles for, per exemple, està bé usar variables
noms com i, j, k i per a la iteració.
Quan es creen les variables Iterador dins dels cicles, és
recomana que ho faci dins el mateix circuit, en lloc
que a l'exterior del bucle, de manera que puguem mantenir variables com
hermèticament àmbit del possible.
>> D'altra banda, un nom de variable com nombre d'ampolles
a l'esquerra a la paret és, mentre descriptiva, massa detallat
i no és necessari.
En l'esdeveniment que voleu crear una variable amb
diverses paraules, separar les paraules amb guions baixos.
Per exemple, is_ready és molt més llegible que isReady.
Està bé per declarar múltiples variables en la mateixa línia.
Però si ho fa, no inicialitzar algunes variables, però
no altres.
Això vol dir alguna cosa així com monedes de deu centaus, centaus int
punt i coma, està bé.
Però int = 0, monedes de deu centaus centaus
punt i coma no ho és.
>> Finalment, en declarar punters, es recomana
que es col · loca l'asterisc al costat de tipus del punter, no
el nom de la variable.
Així int * p es recomana en lloc d'int
* Espai p.
Whoo!
De manera que sembla com un munt de regles per
record, però no et preocupis.
Si alguna vegada té algun dubte, no dubti en consultar als CS50
guia d'estil en línia.
>> Anem a resumir ràpidament la important
qüestions d'estil de codi.
En primer lloc, comentar el codi.
Sempre, sempre, sempre, descriure el que fan les funcions de
amb un comentari de diverses línies i comentar cada poques línies de
codi en línia.
Segon.
Sigui consistent amb el seu format de codi.
Presti atenció a la seva col · locació i ús d'aparells ortopèdics
així com al voltant de tota la paraules clau i operadors.
Finalment, tria descriptius noms de variables.
Les variables han de descriure el valor que representen, però
No hauria de trigar una eternitat en escriure.
>> I això és tot.
Tot això es convertirà ràpidament en una segona naturalesa a mesura que
escriure codi més i més, i vostè codificació es
amb estil en poc temps.
El meu nom és Tommy, i això és CS50.