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

Delphi 原始碼格式撰寫規範(三):組件簡稱對照表與修改歷史管理

     編輯:Delphi

本文為 Delphi 程式碼規範系列第三部分,涵蓋各面板組件標準簡稱對照表(Internet、Data Access、Data Controls、Decision Cube、QReport、Dialogs、Win31、Samples、ActiveX、Midas)以及原始碼修改歷史管理規範。

組件標準簡稱對照表(續)

Internet 頁面

組件簡稱
TClientSocketcsk
TServerSocketssk
TWebDispatcherwbd
TPageProducerpp
TQueryTableProducertp
TDataSetTableProducerdstp
TNMDayTimenmdt
TNMEchonec
TNMFingernf
TNMFtpnftp
TNMHttpnhttp
TNMMsgnMsg
TNMMSGServnmsg
TNMNNTPnntp
TNMPop3npop
TNMUUProcessornuup
TNMSMTPsmtp
TNMStrmnst
TNMStrmServnsts
TNMTimentm
TNMUdpnudp
TPowerSockpsk
TNMGeneralServerngs
THtmlhtml
TNMUrlurl
TSimpleMailsml

Data Access 頁面

組件簡稱
TDataSourceds
TTabletbl
TQueryqry
TStoredProcsp
TDatabasedb
TSessionssn
TBatchMovebm
TUpdateSQLusql

Data Controls 頁面

組件簡稱
TDBGriddbg
TDBNavigatordbn
TDBTextdbt
TDBEditdbe
TDBMemodbm
TDBImagedbi
TDBListBoxdblb
TDBComboBoxdbcb
TDBCheckBoxdbch
TDBRadioGroupdbrg
TDBLookupListBoxdbll
TDBLookupComboBoxdblc
TDBRichEditdbre
TDBCtrlGriddbcg
TDBChartdbch

Decision Cube / QReport / Dialogs / Win31 / Samples / ActiveX / Midas 頁面

Decision Cube: dcb/dcq/dcs/dcp/dcg/dcgr
QReport: qr/qrsd/qrb/qrcb/qrg/qrl/qrt/qre/qrs/qrm/qrrt/qrdr/qrsh/qri/qrdi/qrcr/qrp/qrch
Dialogs: OpenDialog/SaveDialog/OpenPictureDialog/SavePictureDialog/FontDialog/ColorDialog/PrintDialog/PrinterSetupDialog/FindDialog/ReplaceDialog (建議完整命名或 od/sd/opd/spd/fd/cd/pd/psd/fd/rd)
Win31: dbll/dblc/ts/ol/tnb/nb/hdr/flb/dlb/dcb/fcb
Samples: gg/cg/spb/spe/dol/cal/ibea
ActiveX: cfx/vsp/f1b/vtc/grp
Midas: prv/cds/qcds/dcom/olee/sck/rms/mid

修改歷史管理規範

4.1 修改歷史記錄

已納入配置管理的程式檔案,檔頭必須包含修改歷史區塊,每次修改記錄:

  • 修改人
  • 修改時間 (YYYY-MM-DD)
  • 修改原因 (Bug ID / 需求單號 / 重構目的)
  • 修改說明 (具體變更內容摘要)

{
  修改歷史:
  2024-01-15  張三  BUG-1024  修正匯出 Excel 日期格式錯誤,調整 FormatDateTime 格式字串
  2024-02-20  李四  REQ-2056  新增多語系支援,重構字串資源載入機制
  2024-03-10  王五  REFACTOR  提取共用驗證邏輯至 TValidator 單元,消除重複代碼
}

4.2 新增代碼行標記


// 修改人:張三,時間:2024-01-15,說明:新增日期格式參數
  ExportOptions.DateFormat := 'YYYY-MM-DD';
// 修改結束

4.3 刪除代碼行標記


// 修改人:張三,時間:2024-01-15,說明:移除舊版硬編碼格式
//  ExportOptions.DateFormat := 'YYYY/MM/DD';
// 修改結束

4.4 修改代碼行標記(刪除舊 + 新增新)


// 修改人:張三,時間:2024-01-15,說明:統一日期格式為 ISO 8601
//  ExportOptions.DateFormat := 'YYYY/MM/DD';
// 修改結束
// 修改人:張三,時間:2024-01-15,說明:統一日期格式為 ISO 8601
  ExportOptions.DateFormat := 'YYYY-MM-DD';
// 修改結束

現代化工具鏈建議

需求傳統人工方式現代自動化工具
縮排/大小寫/空格人工檢查DelphiFormatter (開源)、Jedi Code Format (JCF)、IDE 內建 Format Source (Ctrl+D)
命名規範檢查Code ReviewPascal Analyzer、SonarQube Delphi Plugin
修改歷史追蹤手寫檔頭Git Blame / History、Git Commit Message 規範 (Conventional Commits)
團隊共享設定文件規範.editorconfig、共享 JCF 設定檔、Git Hooks 強制格式化

建議團隊棄用手寫檔頭修改記錄,改用 Git 提交訊息規範 (如 feat: 新增匯出功能, fix: 修正日期格式) 搭配 git log --oneline 自動生成變更日誌,並配置 Pre-commit Hook 執行 JCF 格式化,確保倉庫代碼風格始終一致。

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