Kaynak Kod Yardım Dökümanı Hazırlama

Delphi'de kod yazma ile ilgili sorularınızı bu foruma yazabilirsiniz.
Cevapla
Kullanıcı avatarı
igny
Üye
Mesajlar: 54
Kayıt: 14 Mar 2008 04:03

Kaynak Kod Yardım Dökümanı Hazırlama

Mesaj gönderen igny »

Arkadaşlar Merhaba.Geliştirdiğimiz delphi programının başka birisinin anlayabileceği şekilde help dökümanı hazırlamam gerekiyor.Bunu sizler nasıl yapıyorsunuz.Program da 600 tane unit var en baştan böyle bir döküman oluşturulmadığı için tek tek yazmam zor.Bunun kolay bir yolu varmı.
Document Insıght gibi programlarla mı hazırlıyorsunuz acaba
Kullanıcı avatarı
csunguray
Üye
Mesajlar: 855
Kayıt: 09 Ara 2006 05:08
Konum: Adana
İletişim:

Re: Kaynak Kod Yardım Dökümanı Hazırlama

Mesaj gönderen csunguray »

Eskiden kaynak kod içerisine açıklamalar yazmak iyi bir şey olarak görülürdü. Sonradan "Eğer açıklama yazmak zorunda kalıyorsanız kod iyi yazılmamış demektir" görüşü yaygınlaşmaya başladı. Ama herkesten bu kadar ileri düzeyde iyi yazılmış kod beklemek mümkün değil.

Delphi'de de Java'daki JavaDoc benzeri bir takım kaynak kod dokümantasyon araçları mevcut. Bunlar işinizi kolaylaştırır mı bilmiyorum ama bu araçları deneyebilirsiniz.

SynProject
http://synopse.info/fossil/wiki?name=SynProject

DelphiCodeToDoc
http://dephicodetodoc.sourceforge.net/index.html

Doc-O-Matic
http://www.doc-o-matic.com
C. Sunguray
csunguray at netbilisim.kom
Net Bilişim Hizmetleri

Sıradan her programcı bilgisayarın anlayabileceği kodlar yazabilir.
Sadece iyi programcılar insanların da anlayabileceği kodlar yazarlar.
Martin Fowler (http://martinfowler.com/)
Kullanıcı avatarı
igny
Üye
Mesajlar: 54
Kayıt: 14 Mar 2008 04:03

Re: Kaynak Kod Yardım Dökümanı Hazırlama

Mesaj gönderen igny »

cavap için teşekkürler.Evet söylediğniz programları denedim.Tam istediğim sonucu alamdım başka bildiğiniz progrmlar varmı acaba.
Kullanıcı avatarı
pasa_yasar
Üye
Mesajlar: 570
Kayıt: 07 Haz 2004 12:35

Re: Kaynak Kod Yardım Dökümanı Hazırlama

Mesaj gönderen pasa_yasar »

DevJet Software buna da bak istersen. Belki işine yarar
Cevapla