經典案例
  • 金融大数据解決方案
  • 汽车大数据解決方案
  • 当局大数据解決方案
  • 铁路大数据解決方案
  • 电力大数据解決方案
  • 军工大数据解決方案
  • 解放军总装备部
  • 中国航天科工集团
  • 航天科技集团

北京軟件開發公司--软件编码设计过程性规范

發布于:2020-01-03 21:14來源:北京軟件開發公司 作者:北京軟件開發公司 點擊:


 

【北京沙巴体育怎么玩科技有限公司 ——(hivekion)是环球领先的IT解決方案提供商,专注IT产品研发与服务,坚持妥当经营、持续创新、开放合作,在安全生产、大数据处理等领域构筑了端到端的解決方案优势,为企业客户提供有竞争力的IT解決方案、 产品和服务, 并致  力于使能未来信息社会、 构建更美好的天下

1.1.編寫目的:


     使用同一编码约定集的主要原因,是使应用程序的结构和编码风格标准化,以便于浏览和理解这段编码。好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观。一組通用目的的編碼約定應該定義完成上述目的所必需的、能讓程序員自由地創建程序邏輯和功能流程的小的请求。編碼約定的目的是使程序易于閱讀和理解,而不是用過份的約束和絕對的限定來束縛程序員本身的創造性。

1.2內容:

     
程序設計語言的特性和風格會直接影響到軟件開發的質量和可維護性。

編碼原則:

     应尽量避免在体系初始化时运行过量的代码。(此處加入詳細原則)
 

  1. 選用控制結構只准許一個入口和一個出口。
  2. 程序語句組成容易識別的塊,每塊只有一個入口和一個出口。
  3. 複雜的結構應該用基本控制結構進行組合嵌套來實現。
  4. 語句中沒有的控制結構,可用一段等價的程序段模擬,但请求該程序段在整個系統應前後一致。
  5. 嚴格控制GOTO語句,僅鄙人列情况才可使用。
  1. 用一個非結構化的程序設計語言去實現一個結構化的構造。
  2. 在某種可以改善而不是損害程序可讀性的情況下。 
     

1.2.1對象命名約定

公式:對象名稱=對象前綴+自定義名稱(自定義名稱要有一定的意義且第一個字母大寫)
說明:如果是不需要對其編碼的對象,那麽對象名用默認對象名。
应该用一致的前綴来命名对象,令人们容易识别对象的类型。下面列出了 Delphi 支持的一些推荐使用的对象约定。

(1)推薦使用的項目前綴
(2)推薦使用的控件前綴
(3)推薦使用的數據訪問對象的前綴用以下前綴來唆使數據訪問對象。

(4)推薦使用的菜單前綴应用程序频繁使用许多菜单控件,对于这些控件具备一组唯一的命名约定很实用。除了前面 "mnu" 标记之外,菜单控件的前綴应该被扩展:对每一级嵌套增长一个附加前綴,将终的菜单的标题放在名稱字符串的后。下表列出了一些例子。

 
菜單標題序列菜單處理器名稱
(此處加入標題序列及處理器名稱

 
 
当使用这类命名约定时,一个特定的菜单组的所有成员一个接一个地列在 Visual Basic 的“属性”窗口中。而且,菜单控件的名字清楚地表示出它们所属的菜单项。
 
(5)爲其它控件選擇前綴
對于上面沒有列出的控件,應該用唯一的由兩個或三個字符組成的前綴使它們標准化,以保持一致性。只有當需要澄清時,才使用多于三個字符的前綴。
 
例如,(此處加入例子

 

 

1.2.2常量和變量命名約定

公式:常量或變量名稱=常量或變量範圍前綴+常量或變量類型前綴+自定義名稱(自定義名稱要有一定的意義且第一個字母大寫)
 
除了對象之外,常量和變量也需要良好格式的命名約定。本節列出了(此處加入變量列表
變量应该老是被定义在尽可能小的範圍内。全局 (Public) 變量可以导致极其复杂的状态机构,并且使一个应用程序的逻辑非常难于理解。全局變量也使代码的重用和保护更加困难。

Delphi中的變量可以有以下範圍:
範圍声明地位 可见地位
過程級(此處加入名稱
模塊級(此處加入名稱
全局(此處加入名稱
較好的編碼習慣是盡可能寫模塊化的代碼。例如,如果應用程序顯示一個對話框,就把要完成這一對話任務所需要的所有控件和代碼放在單一的窗體中。這有助于將應用程序的代碼組織在有用的組件中,並減小它運行時的開銷。
 
除了全局變量(應該是不被傳遞的),過程和函數應該僅對傳遞給它們的對象操作。在過程中使用的全局變量應該在過程起始處的聲明部分中標識出來。
變量範圍前綴
隨著工程大小的增長,劃分變量範圍的工作也迅速增长。在類型前綴的前面放置單字母範圍前綴標明了這種增長,但變量名的長度並沒有增长很多。
 

範圍 前綴 例子
全局 g GstrUserName
模塊級 m MblnCalcInProgress
本地到過程 DblVelocity
 
(此處加入說明
 
變量
声明所有的變量将会(此處加入說明
应该给變量加前綴来指明它们的数据类型。而且前綴可以被扩展,用来指明變量範圍,特别是对大型程序。

 
變量数据类型
用以下前綴来指明一个變量的数据类型。
(此處加入說明
描述變量和过程名
變量或过程名的主体应该使用大小写混合情势,并且应该充足长以描述它的作用。而且,函数名(此處加入函数名稱
对于频繁使用的或长的项,推荐使用标准缩略语以使名稱的长度合理化。一般来说,(此處加入特例說明就困難了。
當使用縮略語時,要確保它們在整個應用程序中的一致性。在一個工程中,如果一會兒使用(此處加入說明問題,將導致不必要的混淆。
 
用戶定義的類型
在一项有许多用户定义类型的大工程中,常常有必要给每种类型一个它自己的三个字符的前綴。如果这些前綴是(此處加入前綴名稱

1.2.3結構化編碼約定

(此處加入约定說明
 
記住以下幾點:
每一个重要變量的声明应该包括(此處加入變量名稱
(2)格式化代碼
因爲許多程序員(此處加入問題

 
(此處加入解决問題的說明
(3)給常量分組
變量和定义的常量应该按功能分组,而不是分散到单独地区或特定文件中。
(4)運算符
(此處加入运算符列表及說明
(5)爲(此處加入問題 查詢創建字符串

(此處加入說明

1.2.4數據源的約定

(此處加入數據源的約定

1.2.5數據庫訪問約定

访问数据库用ODBC drivers/ADO,但如果在有的技术ADO解决不了的情况下可用其他方法。
數據庫訪問技術有:(此處加入說明

1.2.6其他約定

(1)當日期、時間型數據请求嚴格時,(此處加入說明
(2)記錄集應用約束
【北京沙巴体育怎么玩科技有限公司 ——(hivekion)是环球领先的北京軟件開發公司,专注IT产品研发与服务,坚持妥当经营、持续创新、开放合作,在安全生产、大数据处理等领域构筑了端到端的解決方案优势,为企业客户提供有竞争力的IT解決方案、 产品和服务, 并致力于使能未来信息社会、 构建更美好的天下
tag標簽:
------分隔線----------------------------
------分隔線----------------------------
QQ客服热线