Kompüterdə proqramlaşdırarkən, bəzən digər tərtibatçıların kodunuza rahatlıqla baxa bilməsi üçün qeydlər və ya şərhlər buraxmaq lazımdır. İstər açıq mənbə layihəsi olsun, istərsə də özəl bir layihə, birgə inkişaf etdiricilərlə və gələcək inkişaf etdiricilərlə əlaqələndirmək üçün şərhlərə ehtiyac var. Şərhlər olmadan kod sadəcə əlçatmaz olardı.
Addımlar
Addım 1. Bir kompüter proqramına şərh yazmağın məqsədini anlayın
- Oxunaqlılıq burada əsas şeydir. Bir şərhə baxanda bilməlisiniz ki, bu kod xətti deyil, şərhdir.
- Şərh yalnız sizin üçün deyil, kompüter proqramınızın mənbə kodunu oxuya bilən hər kəs üçün faydalı olmalıdır.
Addım 2. Fikrinizi başa düşməyin qısa, sadə bir yolunu düşünün
Şərhlərin bir sənət əsəri olması lazım deyil. Qısa, səliqəli və nöqtəyə düz olmalıdırlar.
Bununla birlikdə, bir şərh üçün birdən çox sətrin istifadəsini maneə törətməməlidir. Məsələ burasındadır ki, məlumatlar oxucuya çatdırılmalıdır
Addım 3. Proqramlaşdırma dili tərəfindən verilən uyğun sintaksisdən istifadə edərək şərh yazın
Addım 4. Yazdığınız şərhin kifayət qədər ətraflı olub olmadığını özünüzdən soruşun
Şərh, mənbə koduna baxan birinə, proqramın bu hissəsinin onu tərtib etmədən və işləmədən etməli olduğunu söyləyə bilməlidir. Şərhiniz buna nail olurmu? Bütün detalları çatdırır?
