3.檔案
關鍵字和關鍵字含義之間使用2個tab分割，保持書寫格式優美。
1個tab採用4個空格。
樣例：
/**
*@brief 檔案簡要功能描述
*@author 作者名稱
*@date 建立、修改日期
*@version 檔案版本
*@warning 特殊警告說明
*@note
@date
@author 修改說明歷史n
*@note
@date
@author 修改說明歷史n-1
*......
*@note
@date
@author 修改說明歷史2
*@note
@date
@author 修改說明歷史1
*/
序號 組成部分 樣例 說明
1. 檔案頭
2. 編譯巨集定義開始 #ifndef dlg_dev_h
3. 包含系統檔案 #include
/**
*@brief 檔案簡要功能描述
*@author 作者名稱
*@date 建立、修改日期
*@version 檔案版本
*@warning 特殊警告說明
*@note @date
@author 修改說明歷史n
*@note @date
@author 修改說明歷史n-1
*......
*@note @date
@author 修改說明歷史2
*@note @date
@author 修改說明歷史1
*/#ifndef dialogdev_h
#define dialogdev_h
#include #include #include "devmanager.h"
#include "devthread.h"
//前置宣告
class cdevcfg;
class cdevinfo;
extern int g_i32devcount;
extern int g_i32devstate;
extern cdevcfg* getdevcfg(int i32index);
extern cdevinfo* handledevinfo(const qstring& strdevcode);
const
int max_dev_name_len = 64;
enum dev_type
;/**
*@class 裝置視窗操作類
*/class rtx_mod cdialogdev : public qdialog, crtdialog
;#endif // dialogdev_h
② 應該在乙個單獨的.h /.hpp檔案中定義乙個類，在乙個單獨的.cpp 檔案中實現這個類。
③ .h 與.cpp 檔案的檔名必須與類名相同。除了類名的首個大寫字母c。
④ 相關模組、相似功能的檔案命名規則一致，統一放到相應的功能**目錄。
① 若幾個類的規模都不大，關係又很密切，比如業務關係，則可在乙個.h 檔案中定義這些類，在乙個.cpp 檔案中實現。
② 對於附屬於較大規模類的乙個很小規模的類， 可以寫在那個大規模類的.h 和.cpp 裡。
① 乙個標頭檔案中類定義最好不要超過5個。
② 乙個標頭檔案中最好能控制在500行之內（不包括注釋）。
③ 乙個標頭檔案中全域性或類的介面/函式最好控制在100個之內。
④ 乙個實現檔案最好能控制在5000行之內（不包括注釋）。
介面規範文件
一.我們系統的一般的介面設計和跨域處理 1.前後端token驗證 初始化操作 public function initialize session start parent initialize header access control allow origin header access con...
日誌規範文件（2）
日誌規範 日誌型別 日誌簡要說明 支援的日誌級別 執行日誌 該日誌主要記錄系統發生的異常資訊，以便於程式人員定位問題。開發人員編寫定位 在try catch塊中的catch部分編寫 即異常發生時 記錄異常詳細資訊。列印內容包含 日誌級別 發生時間 自定義訊息 入參 出參 異常資訊。需要開發人員編寫的...
作業配置規範文件 MS SQL
原文 作業配置規範文件 ms sql 作業配置規範文件 ms sql 文件型別 ms sql 資料庫作業配置規範文件 建立日期 2015 07 30 版本變化 v3.0 修改記錄 修改人 修改日期 版本 修改描述 瀟湘隱者 2015 08 01 v1.0 建立制定文件 瀟湘隱者 2015 08 13...