პროგრამის ხელობა

პირველი ვერსია

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

პროგრამის ხელობა პატარა დაპირებების სწორად შესრულებაა. კოდი მხოლოდ მაშინ არის კარგი, როცა მის მიღმა მდგომი ქცევა გასაგები და საიმედოა.

სახელების მნიშვნელობა

ფუნქციის სახელი, მოკლე კომენტარი და მონაცემის ნათელი ფორმა მომავალ თანამშრომელს დროს უზოგავს. კომენტარმა აშკარა მოქმედება არ უნდა გაიმეოროს; მან უნდა ახსნას, რატომ აირჩიეს ეს გზა და რა პირობა უნდა დარჩეს მართალი.

ასეთ წერაში დიზაინიც ჩანს: თუ აზრის ახსნა ძალიან რთულია, შესაძლოა თვითონ გადაწყვეტაც ზედმეტად რთული იყოს. წაკითხვადი კოდი გუნდური მეხსიერებაა, თუნდაც პროგრამაზე მხოლოდ ერთი ადამიანი მუშაობდეს.

შეცდომასთან ურთიერთობა

ყველა პროგრამა შეცდომას შეხვდება. განსხვავება ის არის, როგორ იქცევა ასეთ დროს: მომხმარებელს გასაგებ გზას სთავაზობს თუ გაურკვეველ შეტყობინებას უტოვებს. დეველოპერსაც სჭირდება საკმარისი ინფორმაცია მიზეზის საპოვნელად, მაგრამ არა ისეთი ლოგი, რომელიც სხვის საიდუმლო მონაცემებს გაამჟღავნებს.

ტექნიკური ხარისხი ამ ბალანსში ჩანს. ყველაზე მშვიდი გამოცდილება ხშირად იმ შრომის შედეგია, რომელსაც მომხმარებელი არასოდეს ხედავს.

მომდევნო ადამიანის დრო

პროგრამაზე მომუშავე ადამიანი შეიძლება თვეების შემდეგ თვითონვე დაუბრუნდეს საკუთარ კოდს და ვეღარ გაიხსენოს, რატომ მოეჩვენა ერთი გზა სწორად. ამიტომ მკაფიო სახელები და მიზეზის აღწერა მხოლოდ გუნდისთვის არ იწერება. ისინი საკუთარ მომავალ დროსაც იცავს.

ყოველ გადაწყვეტილებას ვრცელი დოკუმენტი არ სჭირდება; განსაკუთრებით სასარგებლოა იმ ადგილების ახსნა, სადაც ჩვეულებრივი გამოსავალი შეგნებულად შეიცვალა. როცა ამ მიზეზს ადვილად პოულობ, ცვლილებაც ნაკლებად საშიშია და შეცდომის გამოსწორება უფრო სწრაფი ხდება.

• ფუნქციის დაპირება პირველ რიგში აღწერე.
• კომენტარით მიზეზი ახსენი.
• შეცდომა ადამიანურად და უსაფრთხოდ აჩვენე.

კარგი კოდი მომავალ მკითხველს საკუთარ გადაწყვეტილებებს უხსნის.

— ARKI რედაქცია