Delphi 2007의 HelpInsight 문서

Question

저는 D2007을 사용하고 있으며 HelpInsight 기능(D2005부터 제공됨)을 사용하여 소스 코드를 문서화하려고 합니다.나는 주로 HelpInsight 도구 설명을 작동시키는 데 관심이 있습니다.다양한 웹 서핑과 실험을 통해 다음과 같은 사실을 발견했습니다.

1. 삼중 슬래시(///) 주석 스타일을 사용하면 문서화된 다른 주석 스타일보다 더 자주 작동합니다.즉.: {*! comment *} 그리고 {! comment }
2. 주석은 주석이 필요한 선언보다 앞에 있어야 합니다.대부분의 경우 이는 코드의 인터페이스 섹션에 배치하는 것을 의미합니다.(명백한 예외는 현재 유닛 외부에서 액세스할 수 없어 구현 블록에서 선언되는 유형 및 함수에 대한 것입니다.)
3. 첫 번째 주석은 함수에 대한 주석일 수 없습니다.(즉.이는 유형에 대한 것이어야 합니다. 또는 최소한 HelpInsight 기능이 작동하기 전에 파서가 "type" 키워드를 확인했어야 합니다.)

이러한 "규칙"을 따랐음에도 불구하고 때로는 도움말 통찰력이 내가 작성한 댓글을 찾지 못하는 경우가 있습니다.한 파일은 올바른 HelpInsight 도구 설명을 생성하지 않지만 이 파일을 다른 더미 프로젝트에 포함하면 제대로 작동합니다.

HelpInsight를 작동시키기 위한 다른 지침/요령이 있는 사람이 있나요?

Answer 1

나는 또 다른 주의 사항을 발견했습니다(내 경우에는 "잘못"이었습니다).

HelpInsight 댓글이 있는 단위인 것 같습니다. ~ 해야 하다 프로젝트에 명시적으로 추가되어야 합니다.단순히 프로젝트를 컴파일할 때 검색되는 경로에 유닛을 두는 것만으로는 충분하지 않습니다.

즉, 해당 유닛이 프로젝트의 .dpr / .dproj 파일에 포함되어 있어야 합니다.(프로젝트 | "프로젝트에 추가" 메뉴 옵션 사용)