[Powered by Google Translate] V tem videu pa si bomo ogledali kode slog, kar je nekaj
, ki je blizu in dragi, da moje srce.
Stil opisuje, kako je oblikovano kodo, ki je
neodvisno od tega, kar je oznaka dejansko počne.
Ne samo, da bo dobro ime dobili boljše razred v CS50,
vendar pa bo tudi pomagal napisati kodo, ki je veliko bolj
berljiva in vzdrževati, ki na koncu dneva,
se dogaja, da bo vaše življenje veliko lažje.
>> Tri glavne sestavine slogu kode, da bomo razpravljali
ta video, so komentarji, oblikovanje,
in variabilni imena.
Začnimo s pripombami.
Ne pozabite, da pripombe ne vplivajo na
Funkcionalnost kodo.
Ti služijo le kot koristnih nasvetov za nas programerje.
Dober komentar je treba odgovoriti na eno od dveh vprašanj.
>> Prvič, kaj to kode, ne?
To je kratko in sladko opis namena
vrstice, ki sledijo.
Na primer, morda boste morali najti prostor, kjer vam
izvajajo določene funkcije, da se določi
bug ali kaj spremeniti.
Brez pripomb, boste morda morali por v več vrstic
Koda poskuša ugotoviti, kje je taka možnost.
Ali pa, če je minilo nekaj dni, odkar ste si ogledali enega od
svoje programe, morda ne spomnite, kaj zlasti
funkcije ali zanke ne.
Tako bodo ugotovitve, da se z reacquainting
stara oznaka, ali se seznani z nekoga drugega
Koda, veliko bolj gladko.
Drugo vprašanje dober komentar odgovorov, zato nisem
izvajati ta blok na ta način?
Kot ste napisali kodo, boste pogosto potrebovali
da odločitve o oblikovanju.
Naj uporabljam while zanko ali za zanke tukaj?
Naj bo ta blok kode v posebno funkcijo?
Uporaba pripomb, lahko svojo zasnovo
Odločitve, ki jih bo vaš kodo lažje razumevanje
za druge, ki lahko sami se sprašuje točno isto
oblikovanje vprašanj, kot so branje kode.
Ali pa tudi sami, če prideš nazaj na blok kode po
nekaj časa.
>> V C in drugih jezikih, bomo videli v CS50, obstaja
dva načina, dodajanje komentarjev v kodo, in-line komentarji
in multi-line komentarji.
V vrstice besedila so super za dokumentiranje dela kode
znotraj funkcije.
Na primer, lahko in-line komentar opisujejo
Namen za zanke ali kotno primeru, da zahteva
stanje.
Multi-line komentarji so super za dokumentiranje funkcije.
Kadarkoli napisati funkcijo, morate vedno, vedno,
vedno dokazati, kaj počne s komentarjem.
To vključuje, kaj vložki funkcije so, kaj
Rezultat funkcije je, in morda zakaj je funkcija
izvaja na način, da je.
Kadarkoli spremeniti funkcijo podpis, vrnitev
vrednost ali izvajanje, je pomembno, da tudi posodobiti
ustrezno dokumentacijo komentar.
Neusklajenost med komentarja funkcijo, in
Izvajanje je lahko zelo zavajajoče za bralce.
Prav tako ustvarja večvrstično komentar na vrh
vsakega c ali.. h datoteko, ki jo pišete, ki opisuje, kaj
Datoteka ne, je tudi zelo dobra ideja.
>> Kot ste komentiral svojo kodo, ena od prvih vprašanj, ki jih
morda je tudi, koliko bi mi moj komentar kodo?
To je pogosto nepotrebna dokumentirati vse
eno vrstico kode.
Na primer, vrstica, ki pravi, int x = 5 ne potrebuje
komentar o tem, da je pravi "nastavljena na x 5".
Ni komentiral dovolj, čeprav, kot smo videli, lahko da
razumevanje kodo zelo težko.
Torej, dobro pravilo palca je, da svoje pripombe zanimive blokov
Koda, kjer je blok sestavljen iz nekaj sorodnih linij.
>> Torej si na primer.
Tukaj je odkomentiral C funkcijo.
Ok, saj je to funkcija, je prva stvar, moramo dodati
Komentar je razlagal, kaj je funkcija za vnos
in kaj počne.
Torej dodati več vrstic komentarja.
Čudovito.
Zdaj vemo, kaj naše delovanje ne.
Naj dodamo nekaj na spletnih komentarjev zdaj.
Mi lahko delimo našo kodo v dve skupini podobnih progah.
Vrstice 4 in 5 konstrukt godala temeljijo na podatkih in
črte od 6 do 9 te proizvodnje
strune v lyrics.
Torej, kaj je dokazovanje, da s svojimi pripombami.
Neverjetno.
Zdaj naša naloga je komentiral.
>> Obvestilo, da so naši in-line komentarjev ne potrebujete za uporabo popolne
kazni ali konec z obdobju.
Pomembno je, da obstaja prostor med drugim poševnico
in začetek komentarja.
To je frekvenca pripombe v okviru svojih programov
da bi morali biti streljanje.
Obvestilo tukaj, kako smo se ločili dve bloke povezane kode
znotraj našega refrenom funkcije z dodatnim vrnitev prevoznine.
>> To nas pripelje do naslednje sestavine slogu kode
oblikovanje.
Ko sem prvič začel programiranja, sem zadeti nastopiti
Ključni zelo redko, kar je privedlo do velikana, neberljiv
Blobs kode.
Mislim, da sem dejansko užalil mojega poučevanja kolegi, saj je
ni bil preveč zadovoljen z mano.
Vizualno združevanje blokov kode, povezanih z uporabo prevoz
vrne, lahko vaš kodo lažje prelistati in jasno
razmejiti, katere vrstice kode vaše pripombe pojasnjujejo.
To je rekel, širi svojo kodo preveč, saj s
dve ali več ločnice med blokov kode ali funkcij, lahko
Prav tako bi bilo veliko manj berljivo.
>> Zamik je še en pomemben
vidik obliki kode.
Vedno, vedno, vedno alinea telo funkcije, zanka,
ali stanja.
Zato je jasno, katere vrstice kode so znotraj
zanke, na primer, in kar vrstic kode
zunaj tega.
CS50 priporoča, da alinee s štirimi prostorov, vendar
če izberete kaj drugega, se prepričajte, da je v skladu
skozi svojo kodo.
Na opombo, CS50 priporoča, da si postavite naramnice
na lastno linijo.
Na ta način bo naramnice line up vizualno hkrati levi
kapital, tako da je kristalno jasno, kje blok začne in konča.
Vendar pa je tudi v redu, da se aparat na isti liniji kot
stanje, na primer za ohranitev prostora.
Če to storite, čeprav, poskrbite, da boste tudi prostor
pred kodrasti brace, tako da ni smooshed zraven zapiranje
paren ali besedo.
>> Ne glede na vašo izbiro, najbolj pomembna stvar je, da se
konsistentna v svojo kodo.
Kaj ne želimo videti, čeprav je
razčlenjena zavitih oklepajih.
S tem naredi naramnic zdi odklopiti od
pogoj, zanka, ali funkcija oni razmejitev, s čimer
kodo težko brati.
V C in drugih jezikih, bomo videli, zavitih oklepajih so
izbiri za posamezne pogojih na progi, ali zank.
Saj je v redu, da se izognejo zavite oklepaje v tem primeru, ampak če
to storite, se prepričajte, da je v skladu
skozi svojo kodo.
>> Pri opredelitvi nalog CS50 priporoča, da napišete
vrne vrsto funkcije na isti liniji kot ime
funkcija.
Vendar pa je tudi v redu, da napišete povratni vrste na lastno pobudo
line, ki lahko funkcija opredelitve lažje najti v
nekaj tekstov.
>> Končno, se prepričajte, da so prostore v okolici
ključne besede in izvajalci.
Na primer, vrstica, ki pravi, int x = 5, je veliko lažje
prebrati, če so prostori okoli enačaja.
Prav tako poskrbite, da imate prostor po ključnih besedah ​​všeč, če
za in časa.
Brez prostora, bi to lahko videti kot klici funkcij,
ki niso.
>> Torej si na primer uporabo dobrih slog
na slabo oblikovano blok kode.
Ok, začnimo od začetka.
Vidimo lahko, da začetnega oklepaja za main je na isti
linija kot ime je funkcija je.
Če bomo to storili, mora biti prostor med
zadnji paren in naramnicami, kot je ta.
Vendar CS50 priporoča, da naramnice stati
na lastno linijo.
Torej, kaj je to.
Zdaj, ko smo v telesu glavno funkcijo, bomo potrebovali
Na začetek Feed kodo, bomo uporabili
Priporočeni 4 prostore.
Nato smo videli, da ni prostora okoli enačaja
tukaj, tako da je dodal, da.
Tukaj vidimo, da ni prostora med in po
paren odprta, tako da je dodal, da skupaj z nekaj prostora okoli
večja kot znak.
Spet vidimo, da ni prostora med zadnjim in paren
začetnega oklepaja tukaj.
Če bomo dal to isto linijo, je treba
je prostor pred skodranimi brace.
Vendar pa izgleda, da je telo našega
Pogoj je le ena vrstica.
Tako nam ni treba vključiti aparat sploh.
Zdaj moramo biti prepričani, da alinei v telesu vsakega
naše razmere.
Mi zagotovo ne želite to zadnja linija, ki se na isti
linija kot drugje, tako da je zadeti nastopiti in alinea.
Končno zapiranje kodrasti ortoza za glavne potrebe, da se na
lastno linijo.
>> Tukaj lahko vidite, da smo imeli dva različna
bloki, povezanega kodeksa.
Vrstice od 4 do 6 poziv uporabniku za vnos in
Preostale črte prikazujejo, da je prispevek za uporabnika.
Zato je smiselno, da nekaj prostora med tema dvema blokoma
jasnosti.
In gremo, zdaj pa je ta številka bistveno lažje brati z
dobro ime.
>> Končno, kaj je govoril o našem tretje komponente v dobrem slogu:
imeni spremenljivk.
Vaš imeni spremenljivk mora opisati
Vrednost, ki jo zastopajo.
Naj ponovno naš prejšnji primer.
Steklenice je dobro opisno ime za spremenljivko, ki
predstavlja koliko steklenic je ostalo na steni.
Imena, kot so x, ali numBots niso preveč opisna in so
ni dobro za berljivost kode.
Medtem ko spremenljivke poimenovane z dopisom so pogoste v
matematike in drugih področjih, lahko dajo svojo kodo zelo težko
razumeti.
Izjema od tega pravila je iterator
spremenljivke znotraj zank.
V for zanke, na primer, je že v redu, da uporabite spremenljivko
Imena, kot so I, J in K za ponovitev.
Pri ustvarjanju Iterator spremenljivk v zankah, je
Priporočamo vam, da to storijo v zanki sam, ampak
od zunaj zanke, tako da bomo lahko vodijo spremenljivke, kot
tesno zajeta kot je mogoče.
>> Po drugi strani pa spremenljivka ime kot število steklenic
levo na steni je pa opisuje, preveč verbose
to ni potrebno.
V primeru, da ne želite ustvariti spremenljivko z
Več besed, ločite te besede s poudarjeno.
Na primer, is_ready je veliko bolj berljiva kot isReady.
Saj je v redu, da razglasi več spremenljivk na isti liniji.
Vendar, če boste to storili, ne initialize nekaj spremenljivk, vendar
ni druge.
To pomeni, da nekaj takega int Dimes, penijev
podpičje, je v redu.
Ampak int dimes = 0, penijev
podpičje ni.
>> Nazadnje, ko razglasitvi kazalce, je priporočljivo, da
da postavite zvezdico zraven tipa kazalca, ne
ime spremenljivke.
Torej je int * p priporočljivo namesto int
prostor * str.
Vau!
Tako, da se zdi, kot veliko pravil in
se spomnite, vendar ne skrbite.
Če kdaj v dvomih, ne oklevajte, da se sklicuje na CS50's
spletne slogovni priročnik.
>> Naj hitro povzame pomembna
točke slogu kode.
Prvič, pripombe kodo.
Vedno, vedno, vedno opisujejo, kaj storiti funkcije
z multi-line pripombe in pripomb vsakih nekaj vrstic
Oznaka v liniji.
Drugič.
Biti v skladu s svojo kodo oblikovanja.
Bodite pozorni na svoj namestitev in uporabo naramnic
kot tudi razmik okoli ključnih besed in izvajalci.
Končno, izberite opisna imena spremenljivk.
Spremenljivke opisujejo vrednost, ki jo zastopajo, ampak
naj vas ne bo večno na vrsto.
>> In to je to.
Vse to bo kmalu postala drugi narave, kot ti
napisati več in več kode, in boste kodiranje
s stilom, v nobenem trenutku.
Moje ime je Tommy, in to je CS50.