Компьютер дээр програмчлахдаа бусад хөгжүүлэгчид таны кодыг хялбархан үзэхийн тулд заримдаа тэмдэглэл эсвэл сэтгэгдэл үлдээх шаардлагатай болдог. Нээлттэй эхийн төсөл эсвэл хувийн өмчийн төсөл эсэхээс үл хамааран хамтран хөгжүүлэгчид болон ирээдүйн хөгжүүлэгчидтэй уялдуулахын тулд тайлбар өгөх шаардлагатай байна. Сэтгэгдэл бичихгүй бол кодыг ашиглах боломжгүй болно.
Алхам
Алхам 1. Компьютерийн програмыг тайлбарлах зорилгыг ойлгох
- Унших чадвар бол энд гол зүйл юм. Сэтгэгдлийг харахад энэ нь кодын мөр биш харин сэтгэгдэл гэдгийг мэдэх ёстой.
- Сэтгэгдэл нь зөвхөн танд төдийгүй таны компьютерийн програмын эх кодыг уншиж болох бусад хүмүүст тустай байх ёстой.
Алхам 2. Санаагаа ухамсарлах богино, энгийн аргыг бодоорой
Сэтгэгдэл бол урлагийн бүтээл байх албагүй. Тэд товч, цэвэр, цэгцтэй байх ёстой.
Гэсэн хэдий ч энэ нь тайлбар бичихийн тулд олон мөр ашиглахад саад болохгүй. Гол нь мэдээлэл уншигчдад хүрэх ёстой
Алхам 3. Програмчлалын хэлээр өгсөн зохих синтаксийг ашиглан сэтгэгдлээ бичнэ үү
Алхам 4. Таны бичсэн сэтгэгдэл хангалттай нарийвчилсан эсэхийг өөрөөсөө асуугаарай
Тайлбар нь эх кодыг харж буй хүнд програмын энэ хэсэг яг юу хийж байгааг хөрвүүлэх, ажиллуулахгүйгээр хэлэх боломжтой байх ёстой. Таны сэтгэгдэл үүнийг биелүүлж байна уу? Энэ нь бүх нарийн ширийн зүйлийг хэлж өгдөг үү?