Kur programoni në një kompjuter, ndonjëherë është e nevojshme të lini shënime ose komente në mënyrë që zhvilluesit e tjerë të mund të shfletojnë kodin tuaj me lehtësi. Pavarësisht nëse është një projekt me burim të hapur ose një projekt pronësor, komentet janë të nevojshme për të koordinuar me bashkë-zhvilluesit dhe zhvilluesit e mundshëm të ardhshëm gjithashtu. Pa komente, kodi thjesht do të ishte i pambajtshëm.
Hapa
Hapi 1. Kuptoni qëllimin e komentimit të një programi kompjuterik
- Lexueshmëria është gjëja kryesore këtu. Kur shikoni një koment, duhet të dini se është një koment dhe jo një linjë kodi.
- Komenti gjithashtu duhet të jetë i dobishëm jo vetëm për ju, por për këdo tjetër që mund të lexojë kodin burimor të programit tuaj kompjuterik.
Hapi 2. Mendoni për një mënyrë të shkurtër dhe të thjeshtë për të kapërcyer pikën tuaj
Komentet nuk kanë nevojë të jenë vepër arti. Ato duhet të jenë koncize, të pastra dhe të drejtpërdrejta në pikë.
Sidoqoftë, kjo nuk duhet të dekurajojë përdorimin e linjave të shumta për një koment. Çështja është se informacioni duhet të kalojë tek lexuesi
Hapi 3. Shkruani komentin duke përdorur sintaksën e duhur të dhënë nga gjuha programuese
Hapi 4. Pyesni veten nëse komenti që keni shkruar është mjaft i detajuar
Një koment duhet të jetë në gjendje t'i tregojë dikujt që shikon kodin burimor se çfarë bën në të vërtetë ajo pjesë e programit pa pasur nevojë ta përpilojë dhe ekzekutojë atë. A e arrin komenti juaj këtë? A i përcjell të gjitha detajet?
