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

Delphi 原始碼格式撰寫規範(二):專案目錄結構、檔案命名與組件簡稱對照表

     編輯:Delphi

本文為 Delphi 程式碼規範系列第二部分,涵蓋屬性命名、專案目錄結構、各類檔案命名規則(專案、表單、資料模組、單元)、Form/DataModule 類別與實例命名,以及Standard/Additional/Win32/System 四大面板組件標準簡稱對照表。

3.6 屬性命名

屬性名稱去掉類別變數前綴 F 後與其操作的變數名一致。
例:FUserName: string → 屬性 UserName。

3.7 檔案與目錄規範

3.7.1 專案目錄結構


專案根目錄
├── Bin\          # 編譯輸出 (EXE, BPL, DLL)
├── Db\           # 本地資料庫檔
├── Doc\          # 文件 (需求、設計、測試報告)
├── Hlp\          # 說明檔 (CHM, HLP)
├── Backup\       # 手動備份
└── Tmp\          # 暫存檔

3.7.2 專案檔 (.dpr)

使用有意義名稱,如 SysInfo.dpr。

3.7.3 表單檔 (.dfm/.xfm)

與 Form 類別名一致:TFormMain → FormMain.dfm。

3.7.4 資料模組檔

  • 一般:DM 前綴,如 DMCustomers.dfm
  • 遠端:RDM 前綴,如 RDMCustomers.dfm

3.7.5 單元檔 (.pas)

3.7.6 檔案標頭註解

所有 .pas 檔案開頭必須包含:


{
  修改日期:
  作者:
  用途:
  本模組結構組成:
}

3.7.6 Form / DataModule 類別與實例命名

類型命名規則範例
一般單元Unit + 功能名UnitGeneral.pas
表單單元Unit + Form 類別名UnitFormMain.pas
資料模組單元Unit + DM 類別名UnitDMCustomers.pas
類型類別名 (Type)實例名 (Instance)
FormTForm + 功能名 (如 TAboutForm, TMainForm)去掉 T 前綴 (AboutForm, MainForm)
DataModuleTDM + 功能名 (如 TDMCustomer, TDMOrders)去掉 T 前綴 (DMCustomer, DMOrders)

3.8 組件標準簡稱對照表(前四大面板)

Standard 頁面

組件簡稱
TMainMenumm
TPopupMenupm
TMainMenuItemmmi
TPopupMenuItempmi
TLabellbl
TEditedt
TMemomem
TButtonbtn
TCheckBoxcb
TRadioButtonrb
TListBoxlb
TComboBoxcb
TScrollBarscb
TGroupBoxgb
TRadioGrouprg
TPanelpnl
TCommandListcl

Additional 頁面

組件簡稱
TBitBtnbbtn
TSpeedButtonsb
TMaskEditme
TStringGridsg
TDrawGriddg
TImageimg
TShapeshp
TBevelbvl
TScrollBoxsbx
TCheckListBoxclb
TSplitterspl
TStaticTextstx
TChartcht

Win32 頁面

組件簡稱
TTabControltbc
TPageControlpgc
TImageListil
TRichEditre
TTrackBartbr
TProgressBarprb
TUpDownud
THotKeyhk
TAnimateani
TDateTimePickerdtp
TTreeViewtv
TListViewlv
THeaderControlhdr
TStatusBarstb
TToolBartlb
TCoolBarclb

System 頁面

組件簡稱
TTimertm
TPaintBoxpb
TMediaPlayermp
TOleContainerolec
TDDEClientConvddcc
TDDEClientItemddci
TDDEServerConvddsc
TDDEServerItemddsi

命名應用範例


// 表單單元 UnitFormMain.pas
type
  TMainForm = class(TForm)
    mmMain: TMainMenu;           // mm_ + 功能
    pnlTop: TPanel;              // pnl_ + 位置/功能
    edtUserName: TEdit;          // edt_ + 資料欄位
    btnLogin: TButton;           // btn_ + 動作
    tvOrg: TTreeView;            // tv_ + 業務領域
    qryUser: TQuery;             // qry_ + 查詢對象
  end;

var MainForm: TMainForm; // 實例名去掉 T

統一的簡稱體系能讓團隊成員快速識別組件類型與用途,配合 IDE 的 Code Insight,大幅提升閱讀與維護效率。

  1. 上一篇文章:
  2. 下一篇文章:
Copyright © 程式碼之家 All Rights Reserved