[Powered by Google Translate] Selles videos, me arutada koodi stiili, mis on midagi mis on lähedal ja kallis mu südamesse. Stiil kirjeldab, kuidas oma koodi on vormindatud, mis on sõltumatu mis koodi tegelikult teeb. Mitte ainult hea stiil sulle parema klassi CS50, kuid see aitab teil kirjutada koodi, mis on palju loetav ja hooldatav, mille lõpus päeval, kavatseb teha oma elu palju lihtsam. 

Kolmest põhikomponendist kood stiilis, et saame arutada see video on kommentaarid, vormindamine, ja muutujate nimed. Alustame kommentaare. Pea meeles, et kommentaarid ei mõjuta funktsionaalsust oma kood. Neil on vaid nii kasulikke näpunäiteid meile kui programmeerijad. Hea märkusi tuleks vastata ühele kaks küsimust. 

Esiteks, mida see ploki koodi teha? See on lühike ja magus kirjeldus eesmärgil read, mis järgnevad. Näiteks võib teil olla tarvis leida koht, kus te rakendada eelkõige funktsiooni määrata bug või midagi muuta. Ilma kommentaarid, peate pooride üle palju ridu kood püüdnud aru saada, kus täpselt, et funktsioon on. Või kui see on olnud paar päeva pärast olete vaatasin üks oma programme, siis ei pruugi mäletada, mis eelkõige funktsiooni või silmus teeb. Nii kommentaarid teevad reacquainting ennast vana-koodi või tutvustabki ennast kellegi teise kood, palju sujuvam. Teine küsimus hea kommentaar vastused on põhjus, miks ma tegin rakendada seda plokki sel viisil? Nagu te kirjutada koodi, saate sageli vajadus teha disaini otsuseid. Kas ma peaksin kasutama samas loop või loop siin? Kas ma peaksin tegema seda ploki koodi eraldi funktsioon? Kasutades kommentaarid, saate dokumendi kujunduse otsuseid, mis teevad teie koodi lihtsam mõista teistele, kes võib küsida ise täpselt sama disain küsimustele nagu nad lugeda oma koodi. Isegi ise kui naasta ploki koodi pärast mõne aja jooksul. 

C, ja teistes keeltes me näeme CS50 on kaks võimalust kommentaari lisamiseks oma kood, rea märkusi ja mitmeliiniline kommentaare. In-line kommentaarid on suur dokumenteerimise tükid kood jooksul funktsioone. Näiteks rea arvamus võib kirjeldada eesmärgil jaoks silmus või nurga puhul, mis nõuaks seisukorras. Mitmeliiniline kommentaarid on suur dokumenteerimise funktsioone. Kui sa kirjutad funktsiooni, peate alati, alati, alati dokumenteerida mida ta teeb koos kommentaari. See hõlmab mida sisendite funktsioon on, mida väljund funktsioon on, ja äkki, miks funktsioon on rakendada viisil, et see on. Iga kord, kui muudad funktsiooni allkiri, tagasi väärtus, või rakendamisega, on oluline värskendada ka vastava dokumentatsiooni kommentaari. Erinevus funktsiooni kommentaar ja rakendamine võib tõesti segadust tekitada lugejatele. Samuti luuakse mitmeliiniline kommentaar ülaosas iga. c või. h faili kirjutada, mis kirjeldavad faili ei, on ka väga hea idee. 

Nagu sa kommenteerides oma kood, mis on üks esimesi küsimusi sa oleks on hästi, kui palju peaks ma kommenteerida minu koodi? See on sageli vaja dokumenteerida iga koodirida. Näiteks rida, mis ütleb int x = 5 ei ole vaja kommenteerida seda, mis ütleb "set x 5". Ei kommenteerides piisavalt, kuigi, nagu me oleme näinud, saaksid mõista oma kood väga raske. Nii hea rusikareegel on kommenteerida huvitav plokid kood, kus blokk koosneb mõned nendega seotud liinid. 

Võtame pilk näiteks. Siin on uncommented C funktsioon. Okei, kuna see on funktsioon, esimene asi, me peame lisada on Kommentaari selgitades, mida funktsiooni sisendite on ja mida ta teeb. Nii et lisame mitmeliiniline kommentaari. Suur. Nüüd me teame täpselt, mida meie funktsioon teeb. Olgem lisada mõned rea märkusi nüüd. Me võime jagada meie kood kaks plokki sarnaselt. Ridadel 4 või 5 konstrukti stringid põhinevad sisendi ja read 6 kuni 9 väljund neile stringid jooksul laulule. Nii et olgem dokumenteerima, et koos märkustega. Awesome. Nüüd on meie ülesanne on kommenteeritud. 

Pange tähele, et meie rea märkusi ei ole vaja kasutada täielikku karistused või lõpeb ajavahemik. On oluline, et seal on ruumi vahel teise kaldkriipsuga ja algust kommentaari. See on sagedus jooksul märkusi oma programmides et sa peaksid pildistada. Teade siin kuidas me eraldada kaks plokki seotud kood sees ja meie koori funktsiooni pildi kelgutagastusmärgid. 

See viib meid järgmise osa kood stiil, vormingu. Kui ma hakkas programmeerimine, ma vajuta Enter võti väga harva, mille tulemusena hiiglane, loetamatuks plekid koodi. Ma arvan, et tegelikult solvunud minu õpetamise mehe, kuna ta ei olnud liiga rahul mind. Visuaalselt rühmitades plokid seotud kood, kasutades vedu naaseb, saab teha oma koodi lihtsam koorima ja selgelt piiritlemiseks mis rida koodi oma märkusi selgitada. Nagu öeldud, laialilaotamine oma koodi liiga palju, nagu kahe või enama liinidel kood plokkideks või funktsioone, võib Samuti oleks palju vähem loetav. 

Taane on veel üks oluline aspekt kood formaadis. Alati, alati, alati taane keha funktsioon, silmus, või seisund. See teeb selgeks, mis rida koodi on sees loop, näiteks, ja mis rida koodi on väljaspool seda. CS50 soovitab taandes nelja ruumi, kuid kui sa valid midagi muud, siis kindlasti olema kooskõlas kogu oma koodi. Selle teadmiseks, CS50 soovitab paned traksid oma rida. Nii, traksid rivistama visuaalselt samal vasakul varu, nii et see on kristallselge, kus plokk algab ja lõpeb. Kuid see on ka okei panna traksid samal joonel tingimus, näiteks kokku hoida. Kui sa seda teed, kuigi veenduge sisaldama ruumi Enne lokkis traksidega nii see ei ole smooshed kõrval sulgemine paren või sõna. 

Kumb valida, et kõige tähtsam on olla ühtlasem kogu oma koodi. Mida me ei taha näha, kuigi on liigestatud looksulg. Nii teeb traksid näida lahti tingimusel, silmus, või funktsiooni nad piiritleda, mistõttu kood raskesti loetav. C ja teistes keeltes me näeme, looksulg on vabatahtlik üherealine tingimused ega silmuseid. See on hea jätta looksulg sel juhul, kuid kui te seda teete, siis kindlasti olema kooskõlas kogu oma koodi. 

Kui funktsioonide defineerimise, CS50 soovitab teil kirjutada tagasi tüüpi toimima samal joonel nime funktsioon. Kuid see on ka OK kirjutada naasmise tüüp omal rida, mida saab teha funktsiooni mõisted lihtsam leida mõned teksti toimetajad. 

Lõpuks tuleb kindlasti ka tühikud märksõnad ja ettevõtjad. Näiteks rida, mis ütleb int x = 5 on palju lihtsam lugeda, kui seal on ruumi ümber võrdusmärk. Samuti veenduge, et teil on ruumi pärast märksõnad nagu, kui jaoks, ja samal ajal. Ilma ruumi, need võiks olla funktsioon nõuab, kus nad ei ole. 

Võtame pilk näiteks kohaldamisel hea stiil et valesti vormindatud ploki koodi. Okei, alustame otsast peale. Me näeme, et avava sulu peamine on samal liini funktsiooni nimi. Kui me ei kavatse seda teha, siis peab seal olema ruumi vahel sulgemise paren ja traksidega, nagu see. Kuid CS50 soovitab traksid seista oma rida. Nii et teeme seda. Nüüd, kui oleme kehas põhiülesanne, vajame alustada taandrida koodi; me kasutame Soovitatav nelja ruumi. Järgmine näeme, et seal ei ole ruumi ümber võrdusmärk siin, nii lisame seda. Siin näeme, et puudub vahe, kas ja avatud paren, niiet lisada, et koos mõne ruumi ümber suurem kui märk. Taas näeme seal vahel ei ole tühikut sulgemise paren ja alustava sulu siin. Kui me paneme need samal joonel, on vaja olema ruumi enne lokkis traksidega. Kuid tundub, et keha on meie tingimus on ainult üks rida. Nii et me ei pea sisaldama traksid üldse. Nüüd peame kindlasti alapunktist keha iga meie tingimustes. Me kindlasti ei taha seda viimast rida olema samal rida nagu teisedki, niiet vajuta Enter ja taane. Lõpuks sulgemise lokkis traksidega peamised vajadused olevat oma rida. 

Me näeme siin on meil kaks erinevat plokid seotud kood. Liinid 4 kuni 6 ajendab kasutaja sisend ja Ülejäänud read näidata, et sisend kasutaja. Seega on mõistlik panna ruumi vahel kaks plokki selguse huvides. Ja seal me läheme, nüüd see kood on palju lihtsam lugeda koos hea stiil. 

Lõpuks räägime meie kolmanda osa hea stiil: muutujate nimed. Sinu muutujate nimed tuleks kirjeldada väärtus, et nad esindavad. Vaatame uuesti meie varasem näide. Pudelid on hea kirjeldav nimi muutuja, mis näitab, mitu pudelit jäetakse seinale. Nimed nagu x või numBots ei ole väga kirjeldav ning on ole hea loetavuse oma kood. Kuigi muutujad nimega ühe kirja on levinud matemaatika ja muudes valdkondades, võivad nad oma kood väga raske mõista. Erand sellest reeglist on iteraatori muutujad sees ring. Jaoks silmuseid, näiteks, see on hea kasutada muutuja nimed nagu i, j ja k iteratsiooni. Kui loote iteraatori muutujate silmad, see on soovitatav, et te seda tegema silmus ise pigem kui väljaspool loop, et saaksime hoida muutujaid tihedalt scoped kui võimalik. 

Teiselt poolt, muutuja nimi nagu pudelite arv jääb sein on, samas kirjeldav, liiga paljusõnaline ja ei ole vaja. Kui te soovite luua muutuja mitu sõna, eraldage need sõnad koos alakriipsud. Näiteks is_ready on palju loetav kui isReady. See on hea kuulutada mitut muutujat samal joonel. Siiski, kui te seda teete, ei initsialiseerida mõned muutujad, kuid teised mitte. See tähendab midagi int Dimes, penne semikoolon, on OK. Aga int Dimes = 0, penne semikoolonit ei ole. 

Lõpuks, kui kuulutatakse suunanäitajaks, see on soovitatav et paned tärniga kõrval pointer tüüp, mitte muutuja nimi. Nii int * p asemel on soovitav int ruumi * lk. Hoo! Nii et tundub palju reegleid mäleta, aga ärge muretsege. Kui kunagi Kahtluse korral ärge kartke pöörduda CS50 on online-stiilis juhend. 

Lähme kiiresti kokku oluline punktid koodi stiili. Esiteks kommenteerida oma kood. Alati, alati, alati kirjeldada, mis funktsioone teha koos mitmeliiniline kommentaar ja kommenteerida iga paar rida koodi rea. Teiseks. Ole järjekindel oma koodi formaati. Pöörake tähelepanu oma paigutuse ja kasutamise traksid samuti vahe ümber märksõnad ja ettevõtjad. Lõpuks valida kirjeldav muutuja nimed. Muutujad tuleb kirjeldada väärtus, mida nad esindavad, kuid ei tohiks sind igavesti kirjutada. 

Ja ongi kõik. Kõik see kiiresti muutunud teist laadi kui kirjutage rohkem ja rohkem koodi, ja sa pead olema kodeerimine stiili ei ole aega. Minu nimi on Tommy, ja see on CS50.