首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
您现在的位置: 程式碼之家 >> 編程語言 >  >> 更多程式語言 >> Delphi

Delphi 元件線上說明系統建構:Help 檔案製作、B/K 腳註規範、關鍵字檔案生成與索引整合

     編輯:Delphi

19.3 專業元件文件化:從 RTF 到 Delphi Help 整合

① Help 檔案製作規範

  • 工具不限,需保留 RTF 來源檔以生成關鍵字檔。
  • 編譯後 .HLP/.CNT 與單元檔同目錄。
  • 結構約定:
    • 每元件一主題頁:用途簡述 + 公開屬性/事件/方法說明 (F1 直達)。
    • 主題頁 K 腳註:元件名 Component (如 TMemo Component)。
    • 每新增/修改屬性/事件/方法一主題頁:所屬元件、聲明語法、使用說明。
    • 成員主題頁 K 腳註:成員名 類型 (如 Top property、OnChange event)。
    • 所有頁面需 多檔索引專用腳註 支援全文檢索。

② B 腳註:Delphi 專屬內容敏感說明鍵

F1 於物件檢視器/程式碼編輯器觸發搜尋使用 B 腳註,非標準 WinHelp K 腳註。對照表:

主題頁類型B 腳註格式範例
元件主頁class_類別名class_TMemo
通用屬性/事件頁prop_屬性名 / event_事件名prop_WordWrap / event_OnChange
元件專屬屬性/事件頁prop_類別名屬性名 / event_類別名事件名prop_TMemoWordWrap / event_TMemoOnChange

區分原則: 所有元件共用的屬性 (如 Left) 用通用格式;元件專有屬性 (如 BorderStyle) 用專屬格式避免衝突。

③ 關鍵字檔 (.KWF) 生成與索引整合

  1. DOS 提示字元進入 RTF 目錄。
  2. 執行 KWGEN 專案.HPJ → 產出同名 .KWF。
  3. 將 .KWF、.HLP、編譯後單元檔 (.DCU/.BPL) 放入同一目錄。
  4. 執行 HELPINST → 關鍵字寫入 Delphi 主索引 .HDX。

安裝元件套件時自動觸發索引更新,使用者即可在 IDE 內無縫存取自訂說明。

④ 屬性存儲/載入機制補充 (承前文)

  • 預設機制:DFM 僅儲存非預設值,載入時先預設值後覆蓋。
  • default 指令宣告預設值 (不自動賦值),建構子中顯式設定。
  • stored True/False/方法名 精確控制持久化決策。
  • Loaded 虛擬方法執行載入後初始化 (重建連線、衍生計算等)。
  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved