Merhaba,
Dokümantasyon işi genelde iyi niyetle başlanıp bir yerde ipin koptuğu
bir iştir. Geriye dönük olarak dokümanlarını tamamlayan da pek yoktur; o
nedenle içtenlikle tebrik ediyorum. :)
Dokümantasyon için UML kullanın. UML'de değişik durumlar için değişik
diyagram teknikleri vardır. Amaca uygun tekniği seçerek dokümantasyonun
kullanışlılığı ve anlaşılabilirliği önemli oranda artar.
Sevgiler,
Bora.
On 12.12.2011 17:36, Nuri AKMAN wrote:
Arkadaşlar,
Program yazıyorum ve üzerinden zaman geçtiğinde neyin ne olduğunu ve
nasıl çalıştığını unutuyorum...
Kod içinde bir çok açıklama yazıyorum, değişken adlarımı açık ve
anlaşılır veriyorum. Böylece kodu okuyarak hafızamı canlandırıyorum.
Ancak, bu durum hoşuma gitmiyor. Zaman zaman bir kullanıcı 3 yıl önce
yazdığım bir ekranda "Şu hesap da bu rakama dahil mi?" diye sorduğu
zaman tek tek incelemek zorunda kalıyorum herşeyi....
Durum böyle olunca, program çalışma mantığının dokümante edilmesi
fikri oluştu aklımda: Bu ekrana girildiğinde önce şu fonksiyon
çağrılır, sonra şu, şunu kontrol eder vs.vs.vs. Yani, programın
çalışması sırasında yaptığı her şeyi FlowChart tarzı bir şekilde
dokümante etmeyi düşünüyorum.
FlowChart yeteneğinde bir programla bu iş yapılabilir, ancak programın
kalbini/ana ekranını böyle tarif etmek çok uzun sürer ve takibi zor
olabilir.
Acaba bu konuda tavsiye edeceğiniz bir program/metod var mı?
Selamlar,
Nuri Akman
_______________________________________________
Linux-programlama mailing list
Linux-programlama@liste.linux.org.tr
https://liste.linux.org.tr/mailman/listinfo/linux-programlama
Liste kurallari: http://liste.linux.org.tr/kurallar.php
_______________________________________________
Linux-programlama mailing list
Linux-programlama@liste.linux.org.tr
https://liste.linux.org.tr/mailman/listinfo/linux-programlama
Liste kurallari: http://liste.linux.org.tr/kurallar.php
