2008-09-10 17 views
9

D2007 kullanıyorum ve kaynak kodumu HelpInsight özelliğini kullanarak belgelemeye çalışıyorum (D2005'den beri sağlanmıştır). Ben esas olarak, HelpInsight araç ipuçlarını işe almakla ilgileniyorum. (///) Yorum stil diğer belgelenmiş comment stilleri daha sık çalışır üçlü çizgi kullanmaHelpInsight belgelerini Delphi 2007'de

  1. : Çeşitli Web sörf ve deney itibaren aşağıdaki bulduk. i.e .: {*! comment *} ve {! comment }
  2. Yorumlar, bildirim için hazır olduklarından önce gelmelidir. Çoğu durumda bu, onları kodun arayüz bölümünde yerleştirmek anlamına gelir. (Açık olan istisna, mevcut ünitenin dışından erişilemeyen türler ve işlevler içindir ve bu nedenle uygulama bloğunda bildirilmiştir.)
  3. İlk yorum bir işlev için geçerli olamaz. bazen Yardım-kavrayış sadece gelmez, bu "kurallar" aşağıdaki rağmen

- (ya da en azından HelpInsight özelliği çalışır önce ayrıştırıcı "tip" anahtar kelimesini görmüş olmalı görünür yani bir tür için olmalıdır) Yazdığım yorumları bulmuyorum. Bir dosya, doğru HelpInsight araç ipuçlarını üretmez, ancak bu dosyayı farklı bir sahte projeye eklerseniz, düzgün çalışır.

HelpInsight'ın çalışması için başka herhangi bir işaretçi/püf noktası var mı?

+0

HelpInsight'ı daha kararlı hale getirmek için daha fazla çözüm buldunuz mu? –

cevap

4

Ben

O HelpInsight ile birim açıkça projeye eklenmelidir yorumlar anlaşılmaktadır (benim durumumda "yanlış" buydu) başka ihtar keşfettiler. Birimi, projeyi derlerken aranan bir yolla almak yeterli değildir. Başka bir deyişle, ünite projenin .dpr/.dproj dosyasına eklenmiş olmalıdır. (Project | "Projeye Ekle" menü seçeneğinin kullanılması)

+0

Ve iyi eski Borcadero geleneğinde, bu tek gerçek hala belgelenmemiştir. – JensG

+0

İpuçlarınıza ek olarak, başka bir sorun buldum. Daha sonra bir sınıfta olmayan bir işlev/yordam var, uygulama bölümünde ". " olarak adlandırmanız gerekiyor, aksi halde HelpInsight yalnızca "... içinde bildirilir" ifadesini gösterecektir. –