Programmeerida on sageli keeruline asi, kus võib kiiresti ülevaade kaduda. Eriti suurtes projektides, kus on sadu ridade kaupa koodi, võib olla keeruline mõista kommentaare ja programmeerija kavatsusi jälgida. Siin tulevad mängu kommentaarid. Need on mitte ainult kasulikud enda jaoks, vaid ka kolleegide jaoks, kes võivad töötada sinu koodi kallal või peavad seda tulevikus hooldama. Selles juhendis saad teada, kuidas lisada kommentaare tõhusalt oma C# allikakoodi ning milliseid kommentaaride vorme on olemas.
Olulisemad teadmised
- Üksikrida kommentaarid algavad kahe kaldkriipsuga //.
- Mitmerealine kommentaar luuakse /* ja */ abil.
- Kommentaarid aitavad parandada koodi loetavust ja mõistetavust.
Lihtsad üksikrida kommentaarid
Lihtsa kommentaari lisamiseks pane kaks kaldkriipsu // teksti ette, mida soovid kommentaarina märkida. See on eriti kasulik, et kiiresti selgitada, mida üks rida allikakoodist teeb.
Siin aitab see lugejal kohe mõista, et järgmine rida vastutab teksti „Hallo Welt” väljastamise eest.
Mitmerealine kommentaaride kasutamine
Mõnikord soovid kommenteerida rohkem kui ühte rida. Sellistel juhtudel tulevad mängu mitmerealised kommentaarid. Alustad seda kommentaari /* ja lõpetad selle */. See võimaldab sul omada kommentaaris mitut rida.
Nii saad anda põhjalikumaid selgitusi või märkmeid, ilma et katkestaksid oma koodi voolu.
summary-siltide kasutamine
Lisaks eeltoodud kommentaaridele on olemas spetsiaalsed sildid, mida saad kasutada täiendava teabe andmiseks, eriti dokumenteerimise eesmärgil. Samuti on summary liik, mida saad kasutada oma meetodite dokumenteerimiseks.
summary-silt annab teistele arendajatele selge ülevaate sellest, mida meetod teeb, ilma et peaksid lugema originaalkoodi.
Kokkuvõte kommentaaridest allikakoodis
Kommentaaride lisamine oma allikakoodi on tõhus viis oma kavatsuste selgitamiseks ja oma tarkvara hooldatavuse suurendamiseks. Hea kommenteerimine toetab mitte ainult meeskonnas koostööd, vaid tagab ka, et pead tulevikus vähem aega veetma oma koodi dešifreerimisele.
—
Kokkuvõte – Kommentaarid C#: Kuidas jätta allikakoodis selged jäljed
Üksikrida ja mitmerealiste kommentaaride lisamine oma allikakoodi on lihtne, kuid tõhus viis oma koodi arusaadavuse parandamiseks. Pea meeles, et kommentaaride üle mõistuse mitte kasutada – need peaksid olema kasulikud, kuid mitte ülekoormavad. Kasuta summary-silte meetodite jaoks, kui soovid dokumenteerida, mida need teevad.
Sageli küsitud küsimused
Mis on üksikrida kommentaarid C#?Üksikrida kommentaarid algavad kahe kaldkriipsuga // ja kommenteerivad ühe koodi rea.
Kuidas luua mitmerealisi kommentaare C#?Mitmerealised kommentaarid algavad /* ja lõpevad */, et saaksid korraga kommenteerida mitut rida.
Millal peaksin kasutama kommentaare oma koodis?Kommentaare tuleks kasutada, et anda seletusi oluliste koodilõikude kohta, esitada nende funktsioon või kavatsus ning jätta märkmeid, mis on hoolduse jaoks olulised.
Mis on summary-siltide eesmärk?summary-sildid on mõeldud klasside või meetodite kohta teabe andmiseks, mida saab hiljem dokumentatsioonis kasutada.
