Kai programuojate kompiuteryje, kartais reikia palikti pastabas ar komentarus, kad kiti kūrėjai galėtų lengvai naršyti jūsų kodą. Nesvarbu, ar tai atviro kodo projektas, ar nuosavybės teise turimas projektas, norint gauti koordinavimą su bendrais kūrėjais ir galimais būsimais kūrėjais, reikalingi komentarai. Be komentarų kodas būtų tiesiog neprižiūrimas.
Žingsniai
Žingsnis 1. Supraskite kompiuterio programos komentavimo tikslą
- Svarbiausias dalykas čia yra skaitymas. Kai žiūrite komentarą, turėtumėte žinoti, kad tai yra komentaras, o ne kodo eilutė.
- Komentaras taip pat turėtų būti naudingas ne tik jums, bet ir visiems kitiems, kurie gali perskaityti jūsų kompiuterio programos šaltinio kodą.
Žingsnis 2. Pagalvokite apie trumpą, paprastą būdą, kaip suprasti savo mintį
Komentarai nebūtinai turi būti meno kūrinys. Jos turėtų būti glaustos, tvarkingos ir tiesios.
Tačiau tai neturėtų atgrasyti nuo komentaro kelių eilučių. Esmė ta, kad informacija turi būti pateikta skaitytojui
Žingsnis 3. Parašykite komentarą naudodami atitinkamą programavimo kalbos sintaksę
Žingsnis 4. Paklauskite savęs, ar jūsų parašytas komentaras yra pakankamai išsamus
Komentaras turėtų suteikti galimybę kam nors, žiūrinčiam į šaltinio kodą, pasakyti, ką ta programos dalis iš tikrųjų daro, nereikalaujant jos kompiliuoti ir paleisti. Ar jūsų komentaras tai pasiekia? Ar tai perteikia visas detales?
