Documentación de HelpInsight en Delphi 2007

Question

Estoy usando D2007 y estoy tratando de documentar mi código fuente, usando la función HelpInsight (provista desde D2005). Me interesa principalmente que funcionen las sugerencias de herramientas de HelpInsight. Desde varios navegadores web y experimentación, he encontrado lo siguiente:

1. El uso del estilo de comentario triple slash (///) funciona con más frecuencia que los otros estilos de comentarios documentados. es decir .: {*! comment *} y {! comment }
2. Los comentarios deben preceder a la declaración de que son para. Para la mayoría de los casos, esto significará colocarlos en la sección de interfaz del código. (La excepción obvia es para tipos y funciones que no son accesibles desde fuera de la unidad actual y, por lo tanto, se declaran en el bloque de implementación.)
3. El primer comentario no puede ser para una función. (Es decir, que debe ser para un tipo - o por lo menos parece que el analizador debe haber visto la palabra clave "tipo" antes funciona la característica HelpInsight)

A pesar de seguir estas "reglas", a veces la Ayuda-visión simplemente doesn No encuentro los comentarios que he escrito. Un archivo no produce las sugerencias de herramientas de HelpInsight correctas, pero si incluyo este archivo en un proyecto ficticio diferente, funciona correctamente.

¿Alguien más tiene otros consejos/trucos para que HelpInsight funcione?

Answer 1

he descubierto otra advertencia (que en mi caso era lo que estaba "mal")

Parece ser que la unidad con el HelpInsight comenta debe añadirse explícitamente al proyecto. No es suficiente simplemente tener la unidad en una ruta que se busca al compilar el proyecto.

En otras palabras, la unidad se debe incluir en el archivo .dpr/.dproj del proyecto. (Usando la opción de menú Proyecto | "Agregar al proyecto")