Documentación de HelpInsight en Delphi 2007

Question

Estoy usando D2007 e intento documentar mi código fuente usando la función HelpInsight (proporcionada desde D2005).Lo que más me interesa es que funcionen las sugerencias sobre herramientas de HelpInsight.A partir de diversas experiencias y navegación web, he encontrado lo siguiente:

1. El uso del estilo de comentario de triple barra (///) funciona con más frecuencia que otros estilos de comentarios documentados.es decir.: {*! comment *} y {! comment }
2. Los comentarios deben preceder a la declaración a la que corresponden.En la mayoría de los casos, esto significará colocarlos en la sección de interfaz del código.(La excepción obvia son los tipos y funciones a los que no se puede acceder 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.debe ser para un tipo, o al menos parece que el analizador debe haber visto la palabra clave "tipo" antes de que funcione la función HelpInsight)

A pesar de seguir estas "reglas", a veces la información de ayuda simplemente no encuentra los comentarios que he escrito.Un archivo no produce la información sobre herramientas correcta de HelpInsight, pero si incluyo este archivo en un proyecto ficticio diferente, funciona correctamente.

¿Alguien tiene otros consejos/trucos para hacer que HelpInsight funcione?

Answer 1

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

Parece que la unidad con los comentarios de HelpInsight debe agregarse explícitamente al proyecto.No basta con tener la unidad en una ruta que se busca al compilar el proyecto.

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