Documentazione di HelpInsight in Delphi 2007

Question

Sto utilizzando D2007 e sto cercando di documentare il mio codice sorgente, utilizzando la funzione HelpInsight (fornita a partire dal D2005).Sono principalmente interessato a far funzionare i suggerimenti di HelpInsight.Da varie navigazioni e sperimentazioni sul Web ho trovato quanto segue:

1. L'uso dello stile di commento con tripla barra (///) funziona più spesso degli altri stili di commento documentati.cioè.: {*! comment *} E {! comment }
2. I commenti devono precedere la dichiarazione a cui si riferiscono.Nella maggior parte dei casi ciò significherà inserirli nella sezione interfaccia del codice.(L'ovvia eccezione riguarda i tipi e le funzioni che non sono accessibili dall'esterno dell'unità corrente e sono quindi dichiarati nel blocco di implementazione.)
3. Il primo commento non può riguardare una funzione.(cioè.deve essere per un tipo - o almeno sembra che il parser debba aver visto la parola chiave "tipo" prima che la funzionalità HelpInsight funzioni)

Nonostante segua queste "regole", a volte l'Help-insight non trova i commenti che ho scritto.Un file non produce i suggerimenti corretti di HelpInsight, ma se lo includo in un progetto fittizio diverso, funziona correttamente.

Qualcuno ha altri suggerimenti/trucchi per far funzionare HelpInsight?

Answer 1

Ho scoperto un altro avvertimento (che nel mio caso era ciò che era "sbagliato")

Sembra che l'unità con i commenti di HelpInsight dovere essere esplicitamente aggiunto al progetto.Non è sufficiente avere semplicemente l'unità in un percorso che viene cercato durante la compilazione del progetto.

In altre parole, l'unità deve essere inclusa nel file .dpr / .dproj del Progetto.(Utilizzando l'opzione di menu Progetto | "Aggiungi al progetto")