HelpInsight documentação em Delphi 2007

Question

Eu estou usando D2007 e estou tentando documento o código fonte, usando o HelpInsight recurso (desde D2005).Eu estou principalmente interessado em obter o HelpInsight ferramenta-dicas de trabalho.A partir de vários Web-surfing e experimentação eu encontrei o seguinte:

1. Usando o triplo barra (///) comentário de estilos de obras com mais frequência do que os outros documentado comentário estilos.i.e.: {*! comment *} e {! comment }
2. Os comentários devem preceder a declaração de que eles existem.Para a maioria dos casos, isso significa colocá-los na seção de interface de código.(A óbvia exceção é para os tipos e as funções que não são acessíveis de fora a unidade atual e, portanto, estão declarados na implementação do bloco.)
3. O primeiro comentário não pode ser para uma função.(i.é.ele deve ser de um tipo, ou pelo menos parece que o parser deve ter visto o "tipo" de palavra-chave antes de o HelpInsight recurso funciona)

Apesar de seguir essas "regras", por vezes, a Ajuda-insight simplesmente não encontrar comentários que eu escrevi.Um arquivo não produzir o correto HelpInsight ferramenta-dicas, mas se eu incluir esse arquivo em um outro projeto fictício, ele funciona corretamente.

Alguém tem algum outro ponteiros / truques para ficar HelpInsight para o trabalho?

Answer 1

Eu descobri outra ressalva (que no meu caso era o que estava "errado")

Parece que a unidade com o HelpInsight comentários deve ser explicitamente adicionado para o projeto.Não é suficiente simplesmente ter o aparelho em um caminho que é procurado quando compilar o projecto.

Em outras palavras, a unidade deve ser incluído no Projeto .dpr / .dproj arquivo.(Usando o Project | "Add to Project" opção de menu)