[Powered by Google Translate] Šį video, mes aptarsime kodas stilių, kuris yra kažkas
, kuri yra netoli ir brangūs mano širdžiai.
Stilius aprašoma, kaip jūsų kodas yra suformatuotas, kuris yra
nepriklausomai nuo to, ką kodą iš tiesų.
Bus ne tik geras stilius jums geriau klasė, CS50,
bet tai taip pat padės jums parašyti kodą, kad yra daug
skaitoma ir Patogiausią aptarnavimo, o dienos pabaigoje,
ketina padaryti jūsų gyvenimą daug paprasčiau.
>> Trys pagrindiniai komponentai kodas stiliaus, kad mes aptarsime
šį video komentarai, formatavimo,
ir kintamųjų vardai.
Pradėkime su komentarais.
Atminkite, komentarų neturi įtakos neturi
funkcionalumas savo kodą.
Jie naudojami tik kaip naudingų patarimų, kurie mums, programuotojų.
Geri komentarai turėtų atsakyti į vieną iš dviejų klausimų.
>> Pirma, ką tai kodo blokas daryti?
Tai yra trumpas ir saldus aprašymas tikslui
eilutes, kurios laikytis.
Pavyzdžiui, jums gali tekti rasti vietą, kur jūs
įgyvendinti tam tikrą funkciją, jei norite nustatyti
klaidą ar ką nors pakeisti.
Be komentarų, jums gali tekti porų per daug linijomis
kodas, bando išsiaiškinti, kur tiksliai, kad funkcija yra.
Arba jei jis buvo po kelių dienų nuo tada, kai pažvelgė į vieną iš
savo programas, jūs negalite prisiminti, kas ypač
funkcija arba kilpa.
Taigi, komentarai bus reacquainting save
senas kodas, ar supažindinti save su kažkieno
kodas, daug sklandžiau.
Antrasis klausimas geras komentaras atsakymai yra, kodėl aš
įgyvendinti šį bloką tokiu būdu?
Kaip rašote kodą, jūs dažnai reikia
kad dizaino sprendimus.
Ar galiu naudoti while cikle ar už linijos?
Turėčiau padaryti šį kodo bloką į atskirą funkciją?
Naudojant pastabas, galite dokumentuoti savo dizainą
sprendimai, kurie leis lengviau suprasti jūsų kodas
kitiems, kurie gali būti klausia savęs tą patį
projektavimo klausimus, kaip jie skaito savo kodą.
Ar net sau, jei grįšite į kodo blokas po
tam tikrą laiką.
>> C, o kitomis kalbomis, mes pamatysime CS50 yra
du būdai, pridedant pastabas savo kodą, in-line komentarai
ir kelių linijų komentarai.
In-line komentarai yra puikus dokumentavimo kodo dalis
per funkcijas.
Pavyzdžiui, in-line atsiliepimas gali apibūdinti
tikslas linijos ar kampe, kad dar reikia
sąlyga.
Kelių linijų komentarai puikus dokumentavimo funkcijas.
Kai rašote funkciją, jums reikia visada, visada,
visada dokumentuose, ką ji daro su komentarą.
Tai apima įėjimai į funkciją,
išvesties funkcija yra, o gal todėl, kad funkcija
įgyvendinamos taip, kad ji yra.
Kai jūs pakeisite funkcija parašas, grįžti
vertė, ar įgyvendinimo, labai svarbu, taip pat atnaujinti
atitinkami dokumentai komentaras.
Neatitikimas tarp funkcijos pastabas ir
įgyvendinimas gali būti tikrai paini skaitytojams.
Be to, sukurti kelių eilučių komentuoti viršuje
kiekvieno c arba h failas rašote, apibūdinantį
failas yra, taip pat yra labai gera idėja.
>> Kaip jūs komentuodamas savo kodą, vienas iš pirmųjų klausimų,
galėjo, gerai, kiek reikia komentuoti savo kodą?
Tai dažnai nereikia dokumentuoti kiekvieną
vieną eilutę kodo.
Pavyzdžiui, linija, kuri sako int x = 5, nereikia
pastabas apie tai, kad sako: "nustatyti X 5".
Nekomentuoti pakankamai, nors, kaip matėme, gali padaryti
labai sunku suprasti savo kodą.
Taigi gera nykščio taisykle yra komentarą įdomių blokai
kodas, kai blokas susideda iš kelių susijusių linijų.
>> Todėl galime imtis bent pavyzdžiui išvaizdą.
Štai odkomentowana C funkcija.
Gerai, nes tai yra funkcija, pirmas dalykas, kurį mes turime pridėti
komentaras paaiškinti, ką Ši funkcija įėjimai
yra ir ką ji daro.
Todėl galime pridėti kelių eilučių komentarą.
Didysis.
Dabar mes žinome, ką mūsų funkcija veikia.
Pridėkime kai-line pastabas.
Mūsų kodą Mes galime suskirstyti į du blokus panašiai.
Linijos 4 ir 5 CONSTRUCT stygos, remiantis sąnaudų ir
linijos nuo 6 iki 9 produkcijos tie
stygos per dainų tekstai.
Todėl galime dokumentais patvirtinti, kad su komentarais.
Nuostabus.
Dabar mūsų funkcija komentarų.
>> Pastebėti, kad nereikia naudoti pilnas mūsų in-line komentarai
atėmimo bausmes ar su laikotarpiu, pabaiga.
Svarbu, kad yra tarpas tarp antrojo velniop
komentarą pradžia.
Tai pastabas per jūsų programas; dažnis
kad jums turėtų būti fotografavimo.
Pastebėsite čia, kaip mes atskirti du blokus susijusių kodas
viduje mūsų choras funkciją su papildomu vežimo grįžti.
>> Tai mus atveda prie kito komponento kodas stiliaus,
formatavimas.
Kai aš pirmą kartą pradėjo programavimą, aš paspauskite "Enter"
raktas labai retai, kurio rezultatas buvo milžinas, neįskaitomas
BLOB kodo.
Manau, kad iš tikrųjų įžeidė mano kolegos mokymo, nes ji
nebuvo per daug laimingas su manimi.
Vizualiai grupavimas susijusių kodas blokus, naudojant vežimą
grąžą, kad jūsų kodas lengviau nugriebti ir aiškiai
apibrėžti eilučių kodo jūsų komentarai yra paaiškinti.
Cela dit, išskleidimas kodą per daug, kaip ir
dvi ar daugiau eilučių, tarp kodo blokus ar funkcijų, gali
taip pat tai yra daug mažiau skaitoma.
>> Įdubimas yra dar vienas svarbus
aspektas kodo formatu.
Visada, visada, visada įtraukoje funkcijos kūną, linijos,
arba būklės atkūrimą.
Tai tampa aišku, eilučių kodo viduje
kilpa, pavyzdžiui, ir eilučių kodo
už.
CS50 rekomenduoja, kad jūs įtraukoje keturios erdvės, tačiau
jei jums pasirinkti ką nors kita, būtinai turi būti suderinti
visoje savo kodą.
Dėl šio rašto, CS50 rekomenduoja, kad jūs įdėti petnešos
savo linijos.
Tokiu būdu, petnešos išsirikiuoti vizualiai tuo pačiu kairėje
marža, todėl tai visiškai aišku, kur prasideda ir baigiasi blokas.
Tačiau jis taip pat gerai įdėti petnešos toje pačioje eilutėje kaip
sąlyga, pavyzdžiui, išsaugoti erdvę.
Jei jums tai padaryti, nors, įsitikinkite, kad jums yra vieta,
prieš garbanotas petnešomis todėl nėra smooshed prie uždarymo
skliaustas arba žodis.
>> Kurį pasirinksite, svarbiausia yra tai, kad būtų
nuosekliai visoje savo kodą.
Ką mes darome nenori matyti, nors tai,
įspaudžiami garbanotieji petnešų.
Darydama, petnešos atrodo atjungtas nuo
sąlyga, linijos, arba funkcija, jie pasidalijimo, todėl
kodas sunku skaityti.
C ir kitomis kalbomis mes pamatysime, garbanotas petnešos
pasirinktinai vienos eilutės arba kilpų.
Tai gerai praleisti garbanotas petnešos šiuo atveju, bet jei
tai padarysite, įsitikinkite, kad jos atitinka
visoje savo kodą.
>> , Apibrėžiant funkcijas, CS50 rekomenduoja rašyti
grįžti funkcijos tipą toje pačioje eilutėje kaip ir pavadinimas
funkciją.
Tačiau tai taip pat gerai rašyti savo grįžimo tipo
linija, kuri gali padaryti funkcijų apibrėžimus lengviau rasti
kai kurie teksto redaktoriai.
>> Pagaliau, įsitikinkite, kad įtraukti erdves aplink
raktiniai žodžiai ir operatoriai.
Pavyzdžiui, linija, kuri sako, int x = 5 yra daug lengviau
skaityti, jei yra tarpų aplink lygybės ženklą.
Be to, įsitikinkite, kad turite tarpą po raktiniais žodžiais, pavyzdžiui, jei
, o tuo tarpu.
Be tarpo, tai galėtų atrodyti funkcija skambinti,
kuris joms netaikomas.
>> Todėl galime imtis už gerą stilių taikymo pavyzdys atrodo
blogai suformatuotas kodo bloko.
Gerai, pradėkime iš viršaus.
Mes matome, kad atidarymo petnešomis iš pagrindinių yra apie tą patį
linija, funkcijos vardu.
Jei mes ketiname tai padaryti, turi būti tarpas tarp
uždarymo skliaustas ir petnešomis, kaip šis.
Tačiau CS50 rekomenduoja, kad petnešos
savo linijos.
Taigi, galime padaryti, kad.
Dabar, kad mes ir pagrindinė funkcija organizme, mes jums reikia
pradėti wcięć kodą, mes naudojame
rekomenduojamas keturios erdvės.
Be to, mes matome, kad nėra laisvos vietos aplink lygybės ženklą
čia, todėl galime pridurti, kad.
Čia mes matome, kad tarpas tarp jei ir nėra
atviras skliaustas, todėl galime pridėti, kad, kartu su šiek tiek vietos aplink
didesnis nei ženklo.
Vėlgi, mes matome, nėra tarpas tarp ataskaitinio laikotarpio pabaigos skliaustelius ir
atidarymas petnešomis čia.
Jei mes ketiname įgyvendinti šiuos toje pačioje eilutėje, ten turi
būti tarpas prieš garbanotieji petnešomis.
Tačiau, atrodo, kad mūsų kūno
sąlyga yra tik viena eilutė.
Taigi mums nereikia įtraukti petnešos.
Dabar mes turime būti tikri, jei norite padidinti įtrauką kiekvieno iš kūno
mūsų sąlygomis.
Mes tikrai nenorite, tai paskutinė eilutė turi būti toje pačioje
linija, kaip ir kitur, tad paspauskite Enter įtraukoje.
Galiausiai, uždarymo garbanotas petnešomis pagrindiniai poreikiai
atskiroje eilutėje.
>> Mes galime pamatyti čia mes turime dvi skirtingas
susijusios kodas blokai.
Per 6 4 linijos greitai vartotojo įvesties ir
likusios linijos rodyti, kad prisidėti prie vartotojo.
Taigi prasminga šiek tiek erdvės tarp šių dviejų blokų
dėl aiškumo.
Ir ten eiti, o dabar šis kodas yra daug lengviau skaityti su
geras stilius.
>> Galiausiai, pakalbėkime apie mūsų trečiojo komponento gero stiliaus:
kintamųjų vardai.
Jūsų kintamųjų vardai turėtų būti aprašyti
vertė, kad jie atstovauja.
Leiskite peržiūrėti mūsų ankstesniame pavyzdyje.
Buteliai yra geras pavadinimas kintamojo, kad
atstovauja kiek buteliai paliekami ant sienos.
Pavadinimai, pavyzdžiui, X arba numBots nėra labai aprašomasis ir
nėra gerai jūsų kodo skaitomumą.
Nors kintamieji pavadinta viena raide yra paplitusi
matematikos ir kitose srityse, jie gali padaryti labai sunku kodą
suprasti.
Išimtis iš šios taisyklės yra iteratorius
kintamieji viduje kilpos.
Kilpos, pavyzdžiui, tai gerai naudoti kintamąjį
pavadinimai, pavyzdžiui, I, J ir K iteracijos.
Kurdami Iterator kintamuosius per kilpas, tai
rekomenduojama, kad jūs padaryti kilpa viduje, o
kilpos, nei išorėje, kad mes galime išlaikyti kintamuosius
sandariai aprėptis, kaip įmanoma.
>> Kita vertus, kintamojo vardas, pavyzdžiui, butelių skaičius
palikti ant sienos, o aprašomasis, pernelyg verbose
ir nėra būtina.
Tuo atveju, jei jūs norite sukurti kintamąjį
kelių žodžių, atskirkite šiuos žodžius pabraukimo.
Pavyzdžiui, is_ready yra daug daugiau sklandžiai skaitoma kaip isReady.
Keletą kintamųjų tai gerai paskelbti toje pačioje eilutėje.
Tačiau, jei jums tai padaryti, nereikia inicijuoti keletą kintamųjų, bet
ne kitiems.
Tai reiškia, kad kažkas panašaus į int dimes, centus
kabliataškis, yra gerai.
Bet int dimes = 0, centus
kabliataškis nėra.
>> Galiausiai, kai deklaruojant patarimų, rekomenduojama
, kad jūs įdėti žvaigždutę šalia žymiklį tipo, o ne
kintamojo pavadinimas.
Taigi, int * p yra rekomenduojama, o ne int
erdvė * p.
Whoo!
Taip, kad atrodo, kad daug taisyklių
prisiminti, bet nesijaudinkite.
Jei kada nors kyla abejonių, nedvejodami kreiptis į CS50
interneto stiliaus vadovas.
>> Leiskite greitai apibendrinti svarbus
taškų kodų stiliaus.
Pirma, komentuoti savo kodą.
Visada, visada, visada aprašyti, kokias funkcijas padaryti
su kelių eilučių komentarą ir komentuoti kas keletą eilučių
kodas-line.
Sekundę.
Būti suderinamas su jūsų kodo formatavimą.
Atkreipti dėmesį į savo vietą ir naudojimo petnešos
taip pat tarpai tarp raktinių žodžių ir operatorių.
Galiausiai, pasirinkti aprašomojo kintamųjų vardai.
Kintamieji turi aprašyti vertę, kurią jos atstovauja, bet
ne jus amžinai įvesti.
>> Ir viskas.
Visa tai greitai taps savaime suprantamu dalyku, kaip jūs
parašyti daugiau ir daugiau kodą, ir jums bus kodavimo
stiliaus ne kartą.
My name is Tommy, ir tai yra CS50.