經(jīng)典案例
  • 金融大數據解決方案
  • 汽車(chē)大數據解決方案
  • 政府大數據解決方案
  • 鐵路大數據解決方案
  • 電力大數據解決方案
  • 軍工大數據解決方案
  • 解放軍總裝備部
  • 中國航天科工集團
  • 航天科技集團

北京軟件開(kāi)發(fā)公司--軟件編碼設計過(guò)程性規范

發(fā)布于:2020-01-03 21:14來(lái)源:北京軟件開(kāi)發(fā)公司 作者:北京軟件開(kāi)發(fā)公司 點(diǎn)擊:


 

【北京華盛恒輝科技有限公司 ——(hivekion)是全球領(lǐng)先的IT解決方案提供商,專(zhuān)注IT產(chǎn)品研發(fā)與服務(wù),堅持穩健經(jīng)營(yíng)、持續創(chuàng )新、開(kāi)放合作,在安全生產(chǎn)、大數據處理等領(lǐng)域構筑了端到端的解決方案優(yōu)勢,為企業(yè)客戶(hù)提供有競爭力的IT解決方案、 產(chǎn)品和服務(wù), 并致  力于使能未來(lái)信息社會(huì )、 構建更美好的世界。

1.1.編寫(xiě)目的:


     使用統一編碼約定集的主要原因,是使應用程序的結構和編碼風(fēng)格標準化,以便于閱讀和理解這段編碼。好的編碼約定可使源代碼嚴謹、可讀性強且意義清楚,與其它語(yǔ)言約定相一致,并且盡可能的直觀(guān)。一組通用目的的編碼約定應該定義完成上述目的所必需的、能讓程序員自由地創(chuàng )建程序邏輯和功能流程的小的要求。編碼約定的目的是使程序易于閱讀和理解,而不是用過(guò)份的約束和絕對的限制來(lái)束縛程序員本身的創(chuàng )造性。

1.2內容:

     
程序設計語(yǔ)言的特性和風(fēng)格會(huì )直接影響到軟件開(kāi)發(fā)的質(zhì)量和可維護性。

編碼原則:

     應盡量避免在系統初始化時(shí)運行過(guò)多的代碼。(此處加入詳細原則)
 

  1. 選用控制結構只準許一個(gè)入口和一個(gè)出口。
  2. 程序語(yǔ)句組成容易識別的塊,每塊只有一個(gè)入口和一個(gè)出口。
  3. 復雜的結構應該用基本控制結構進(jìn)行組合嵌套來(lái)實(shí)現。
  4. 語(yǔ)句中沒(méi)有的控制結構,可用一段等價(jià)的程序段模擬,但要求該程序段在整個(gè)系統應前后一致。
  5. 嚴格控制GOTO語(yǔ)句,僅在下列情形才可使用。
  1. 用一個(gè)非結構化的程序設計語(yǔ)言去實(shí)現一個(gè)結構化的構造。
  2. 在某種可以改善而不是損害程序可讀性的情況下。 
     

1.2.1對象命名約定

公式:對象名稱(chēng)=對象前綴+自定義名稱(chēng)(自定義名稱(chēng)要有一定的意義且第一個(gè)字母大寫(xiě))
說(shuō)明:如果是不需要對其編碼的對象,那么對象名用默認對象名。
應該用一致的前綴來(lái)命名對象,使人們容易識別對象的類(lèi)型。下面列出了 Delphi 支持的一些推薦使用的對象約定。

(1)推薦使用的項目前綴
(2)推薦使用的控件前綴
(3)推薦使用的數據訪(fǎng)問(wèn)對象的前綴用下列前綴來(lái)指示數據訪(fǎng)問(wèn)對象。

(4)推薦使用的菜單前綴應用程序頻繁使用許多菜單控件,對于這些控件具備一組唯一的命名約定很實(shí)用。除了前面 "mnu" 標記以外,菜單控件的前綴應該被擴展:對每一級嵌套增加一個(gè)附加前綴,將終的菜單的標題放在名稱(chēng)字符串的后。下表列出了一些例子。

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

 
 
當使用這種命名約定時(shí),一個(gè)特定的菜單組的所有成員一個(gè)接一個(gè)地列在 Visual Basic 的“屬性”窗口中。而且,菜單控件的名字清楚地表示出它們所屬的菜單項。
 
(5)為其它控件選擇前綴
對于上面沒(méi)有列出的控件,應該用唯一的由兩個(gè)或三個(gè)字符組成的前綴使它們標準化,以保持一致性。只有當需要澄清時(shí),才使用多于三個(gè)字符的前綴。
 
例如,(此處加入例子

 

 

1.2.2常量和變量命名約定

公式:常量或變量名稱(chēng)=常量或變量范圍前綴+常量或變量類(lèi)型前綴+自定義名稱(chēng)(自定義名稱(chēng)要有一定的意義且第一個(gè)字母大寫(xiě))
 
除了對象之外,常量和變量也需要良好格式的命名約定。本節列出了(此處加入變量列表。
變量應該總是被定義在盡可能小的范圍內。全局 (Public) 變量可以導致極其復雜的狀態(tài)機構,并且使一個(gè)應用程序的邏輯非常難于理解。全局變量也使代碼的重用和維護更加困難。

Delphi中的變量可以有下列范圍:
范圍聲明位置 可見(jiàn)位置
過(guò)程級(此處加入名稱(chēng)
模塊級(此處加入名稱(chēng)
全局(此處加入名稱(chēng)。
較好的編碼習慣是盡可能寫(xiě)模塊化的代碼。例如,如果應用程序顯示一個(gè)對話(huà)框,就把要完成這一對話(huà)任務(wù)所需要的所有控件和代碼放在單一的窗體中。這有助于將應用程序的代碼組織在有用的組件中,并減小它運行時(shí)的開(kāi)銷(xiāo)。
 
除了全局變量(應該是不被傳遞的),過(guò)程和函數應該僅對傳遞給它們的對象操作。在過(guò)程中使用的全局變量應該在過(guò)程起始處的聲明部分中標識出來(lái)。
變量范圍前綴
隨著(zhù)工程大小的增長(cháng),劃分變量范圍的工作也迅速增加。在類(lèi)型前綴的前面放置單字母范圍前綴標明了這種增長(cháng),但變量名的長(cháng)度并沒(méi)有增加很多。
 

范圍 前綴 例子
全局 g GstrUserName
模塊級 m MblnCalcInProgress
本地到過(guò)程 無(wú) DblVelocity
 
(此處加入說(shuō)明
 
變量
聲明所有的變量將會(huì )(此處加入說(shuō)明。
應該給變量加前綴來(lái)指明它們的數據類(lèi)型。而且前綴可以被擴展,用來(lái)指明變量范圍,特別是對大型程序。

 
變量數據類(lèi)型
用下列前綴來(lái)指明一個(gè)變量的數據類(lèi)型。
(此處加入說(shuō)明
描述變量和過(guò)程名
變量或過(guò)程名的主體應該使用大小寫(xiě)混合形式,并且應該足夠長(cháng)以描述它的作用。而且,函數名(此處加入函數名稱(chēng)。
對于頻繁使用的或長(cháng)的項,推薦使用標準縮略語(yǔ)以使名稱(chēng)的長(cháng)度合理化。一般來(lái)說(shuō),(此處加入特例說(shuō)明就困難了。
當使用縮略語(yǔ)時(shí),要確保它們在整個(gè)應用程序中的一致性。在一個(gè)工程中,如果一會(huì )兒使用(此處加入說(shuō)明問(wèn)題,將導致不必要的混淆。
 
用戶(hù)定義的類(lèi)型
在一項有許多用戶(hù)定義類(lèi)型的大工程中,常常有必要給每種類(lèi)型一個(gè)它自己的三個(gè)字符的前綴。如果這些前綴是(此處加入前綴名稱(chēng)。

1.2.3結構化編碼約定

(此處加入約定說(shuō)明
 
記住下列幾點(diǎn):
每一個(gè)重要變量的聲明應該包括(此處加入變量名稱(chēng)。
(2)格式化代碼
因為許多程序員(此處加入問(wèn)題

 
(此處加入解決問(wèn)題的說(shuō)明
(3)給常量分組
變量和定義的常量應該按功能分組,而不是分散到單獨區域或特定文件中。
(4)運算符
(此處加入運算符列表及說(shuō)明
(5)為(此處加入問(wèn)題 查詢(xún)創(chuàng )建字符串

(此處加入說(shuō)明

1.2.4數據源的約定

(此處加入數據源的約定

1.2.5數據庫訪(fǎng)問(wèn)約定

訪(fǎng)問(wèn)數據庫用ODBC drivers/ADO,但如果在有的技術(shù)ADO解決不了的情況下可用其他方法。
數據庫訪(fǎng)問(wèn)技術(shù)有:(此處加入說(shuō)明

1.2.6其他約定

(1)當日期、時(shí)間型數據要求嚴格時(shí),(此處加入說(shuō)明
(2)記錄集應用約束
【北京華盛恒輝科技有限公司 ——(hivekion)是全球領(lǐng)先的北京軟件開(kāi)發(fā)公司,專(zhuān)注IT產(chǎn)品研發(fā)與服務(wù),堅持穩健經(jīng)營(yíng)、持續創(chuàng )新、開(kāi)放合作,在安全生產(chǎn)、大數據處理等領(lǐng)域構筑了端到端的解決方案優(yōu)勢,為企業(yè)客戶(hù)提供有競爭力的IT解決方案、 產(chǎn)品和服務(wù), 并致力于使能未來(lái)信息社會(huì )、 構建更美好的世界。
tag標簽:
------分隔線(xiàn)----------------------------
------分隔線(xiàn)----------------------------
QQ客服熱線(xiàn)