Комментарийлер: кодуңдагы эскертмелер
Компьютер өткөрүп жиберген, бирок адамдар окуган кичинекей эскертмелер
- комментарий деген эмне экенин жөнөкөй сөз менен айта аласың,
- эмне үчүн компьютер комментарийлерди этибарга албай, адамдар окурун түшүндүрө аласың,
- кодго эскертме калтыруунун жакшы себептерин атай аласың.
1. Комментарий деген эмне?
Код нускамаларга толо — компьютер аткарган кадамдарга. Бирок программада өзгөчө сап да болушу мүмкүн — комментарий. Комментарий — бул адамдар үчүн эскертме. Компьютер аны көрбөгөндөй кылат: аны аттап өтүп, чыныгы нускамаларды гана аткарат.
Комментарийди өзгөчө белги менен белгилешет, компьютер аны өткөрүп жиберишин билиши үчүн. Көп тилдерде бул эскертменин башындагы // же #. Белгилерди азырынча жаттоонун кереги жок — маанилүү ой жөнөкөй: комментарий — компьютер этибарга албаган, адамдар окуган эскертме.
2. Эмне үчүн кодго эскертме калтырабыз?
Комментарийлер программаны тездетпейт жана жаңы эч нерсе кылбайт. Анда эмне үчүн жазабыз? Анткени кодду адамдар окуйт, компьютерлер гана эмес. Жакшы эскертмелер көп нерседе жардам берет:
- «Эмне үчүн» экенин түшүндүрөт. Код эмне болорун көрсөтөт; комментарий эмне үчүн так ушундай кылганыңды айта алат.
- Келечектеги сага жардам берет. Бир нече жумадан кийин кайтып келгениңде, эскертме эмне ойлогонуңду эске салат.
- Командага жардам берет. Башкалар эскертмеңди окуп, кодуңду тезирээк түшүнөт.
- Эскертүү калтырат. Кыска «TODO» эскертмеси бир нерсени кийин бүтүрүүнү эске салат.
- Кодду убактылуу өчүрөт. Сапты комментарийге айландырып, текшерүү учурунда аны жашырса болот — өчүрбөй туруп.
Түшүнүктүү эскертме калтыруу — боорукер, кылдат кодердин ишинин бир бөлүгү. Бул кодуңду кийин окуган адамга белек — ал адам көбүнчө өзүң!