კომპიუტერზე პროგრამირებისას, ზოგჯერ საჭიროა დატოვოთ ჩანაწერები ან კომენტარები, რათა სხვა დეველოპერებმა ადვილად დაათვალიერონ თქვენი კოდი. იქნება ეს ღია კოდის პროექტი თუ საკუთრების პროექტი, საჭიროა კომენტარები, რათა კოორდინირდეს თანა დეველოპერებთან და მომავალ დეველოპერებთანაც. კომენტარების გარეშე, კოდი უბრალოდ არ იქნებოდა შენარჩუნებული.
ნაბიჯები
ნაბიჯი 1. გაეცანით კომპიუტერული პროგრამის კომენტირების მიზანს
- წაკითხვის უნარი აქ მთავარია. როდესაც უყურებთ კომენტარს, თქვენ უნდა იცოდეთ, რომ ეს არის კომენტარი და არა კოდის ხაზი.
- კომენტარი ასევე სასარგებლო უნდა იყოს არა მხოლოდ თქვენთვის, არამედ ვინმესთვის, ვინც წაიკითხავს თქვენი კომპიუტერის პროგრამის კოდს.
ნაბიჯი 2. მოიფიქრეთ მოკლე, მარტივი გზა თქვენი აზრის გასარკვევად
კომენტარები არ უნდა იყოს ხელოვნების ნიმუში. ისინი უნდა იყოს ლაკონური, სისუფთავე და სწორი.
ამასთან, ეს არ უნდა იმედგაცრუებდეს კომენტარისთვის მრავალი სტრიქონის გამოყენებას. საქმე იმაშია, რომ ინფორმაცია მკითხველს უნდა მიეწოდოს
ნაბიჯი 3. დაწერეთ კომენტარი პროგრამული ენის მიერ მოცემული შესაბამისი სინტაქსის გამოყენებით
ნაბიჯი 4. ჰკითხეთ საკუთარ თავს, არის თუ არა თქვენს მიერ დაწერილი კომენტარი საკმარისად დეტალური
კომენტარს უნდა შეეძლოს ვინმეს შეხედოს წყაროს კოდს რას აკეთებს პროგრამის ეს ნაწილი სინამდვილეში მისი შედგენისა და გაშვების გარეშე. თქვენი კომენტარი ასრულებს ამას? ის ხომ ყველა დეტალს გადმოსცემს?
