Dökümantasyon Niye Bu Kadar Önemli?

Dökümantasyon Niye Bu Kadar Önemli?

Bir uygulama yazarsınız. Bu uygulama oldukça optimizedir, piyasada aynı işi yapan diğerlerinin arasında en hızlı olanıdır, bir sanat eseridir ama eğer bu kodu okuyan bunu anlamıyorsa tek kelimeyle çöptür.

Niye mi? Çünkü sizin yaptığınız işi sizden başka kimse anlamıyor. Anlamadıktan sonra da onu kimse kullanmıyor. Hepsini geçtim, o yazdığınız koda 2 ay hiç dokunmayın, açıp bakmayın bile. 2 ayın sonunda kodu okumaya başladığınızda kendi yazdığınızı anlamayacaksınız. Neden? Çünkü o kodu yazarken iki satır yorum yazmaya üşendiniz ama şimdi önümüzdeki 3 gün kodu anlamayla geçireceksiniz. Kolay gelsin.

Bunların haricinde mesela şirketinizde size bir proje verildi ve 5 kişilik grup oluşturuldu. Herkes bir parça kod yazdı ve en son hepsi toplandı. Şu an 5 kişi onun üstünde beraber çalışıyorsunuz. Her şey çok güzel gidiyor, derken arkadaşınız işten ayrıldı. Kaldınız onun yazdığı kodla baş başa. Kod olmuş 1000 satır ve bu 1000 satırın içinde tek satır yorum yok. Nasıl his, güzel değil mi?

Çok zor değil Doxygen diye bir olay var belki duymuşsunuzdur. Eclipse ile entegrasyonu da yapılabiliyor. Ne mi bu Doxygen? Kısa süre içinde yazmayı düşünüyorum şimdilik Google amca ile baş başasınız.

Bir Cevap Yazın

E-posta hesabınız yayımlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir