軟體專案質量保證 編碼規範

2021-09-08 16:12:11 字數 2510 閱讀 7804

目錄

一 編碼規範的作用

二 編碼規範不是「物神」

三 編寫編碼規範的一些建議

四 編碼規範參考

作為軟體開發者,我們可以開發低等級的軟體,但不能開發低質量的軟體。所以,如何實施質量保證,是我們關注的主要問題之一,而編碼規範則是實施質量保證的第一步。

編碼規範已經成為乙個老生常談的問題,幾乎每個專案,每家公司都會定義自己的編碼規範。但在真正實施時,卻在有意或無意地違背編碼規範。程式設計師,不喜歡改變自己的程式設計習慣。加之,管理者對質量控制不足,導致編碼規範往往形同虛設。有些人會認為:遵守編碼規範不能給專案帶來利益,也不能讓客戶看到我們為此付出的努力,其完全是團隊自發的行為,沒有必要做硬性的要求。還有些人有更好的理由:編碼規範會破壞創造性和程式質量。我認為,編碼規範,在軟體構件以及專案管理中,甚至是個人成長方面,都發揮著重要的作用,好的編碼規範是提高我們**質量的最有效的工具之一。

一 編碼規範的作用

二 編碼規範不是「物神」

在高質量的軟體中,你可以看到「架構的概念完整性」與「底層實現」之間的關係。「實現」與「架構」必須是清晰一致的,這種內在的、固有的一致性,需要編碼規範來維繫。如果沒有這種統一的約定,那麼我們做出的東西可能會充斥著各種不同的風格,顯得混亂且難以理解。團隊成員之間可能很不理解彼此之間的想法,甚至是相互抨擊。各種編碼風格上的差異會不斷擴大,而**質量則不斷下降。而且,團隊成員會花費時間在理解不同程式設計風格之間的差異,而沒有專注於真正應該解決的問題。這樣的時間消耗是難以接受的。所以,在每乙個高質量**的背後,一定存在著乙份優秀的編碼規範。

然而,也必須認識到編碼規範不是「物神」。編碼規範僅僅是乙個全域性性質的規範,它只不過是一種程式設計約定,不能解決更深層次的問題。就像一篇格式漂亮但內容糟糕的**不能被發表一樣,你不能僅靠乙個規範來擺脫軟體作坊。而且,在編碼規範中不宜包含那些冗長的開發技巧。我認為,對於**是最佳實踐應該是**審查所要解決的,應該避免將編碼規範寫成一部關於重構的教科書。

三 編寫編碼規範的一些建議

以下是我對定義編碼規範的一些建議:

四 編碼規範參考

我本人不太推薦制定過細的編碼規範。制定編碼規範是為了增強**的可讀性,畢竟**的結構才是主要關注問題,所以我的編碼規範還是比較簡短的。裡面只是對可能會破壞編碼風格的行為進行約束,而沒有細化到「空行」甚至「空格」的級別。

編碼規範

一 命名空間

《公司名稱》.(《產品名稱》|《相關技術》)[.《用途》] [.《子命名空間》]

二 **風格

三 命名規範

(一) 類、結構和介面的命名

基類 派生類

system.attribute

要給自定義的特性新增「attribute」字尾

system.delegate

要給用於事件處理的委託新增「eventhandler」字尾

要給用於事件處理之外的那些委託新增「callback」字尾

不要給委託新增「delegate」字尾

system.eventargs

要新增「eventargs」字尾

system.exception

要新增「exception」字尾

idictionary,idictionary

要新增「dictionary」字尾

ienumerable,icollection,ilist,

ienumerable,icollection,ilist

新增「collection」字尾

system.io.stream

新增「stream」字尾

codeaccesspermission,ipermission

新增「permission」字尾

(二) 成員的命名

成員 大小寫

規範 方法

pascal(公開)、camel(私有)

用動詞或動詞短語命名

屬性 pascal

用名詞、名詞短語或形容詞來命名

集合屬性應該使用複數形式,而不是新增字尾

用「is」、「can」、「has」等表示布林屬性

可以用屬性的型別名來命名屬性

事件 pascal

使用動詞或動詞短語來命名事件

用現在時和過去時來區分前置和後置事件

字段 camel(私有)

要用名詞、名詞短語或形容詞來命名

不要加任何字首

(三) 引數的命名

(四) 常量、變數的命名

(五) 列舉的命名

(六) 資源的命名

(七) 資料庫命名

(八) xml命名

節點名稱使用pascal風格,屬性名稱使用camel風格。

四 注釋

五 異常處理

軟體專案質量保證 編碼規範

一 編碼規範的作用 二 編碼規範不是 物神 三 編寫編碼規範的一些建議 四 編碼規範參考 作為軟體開發者,我們可以開發低等級的軟體,但不能開發低質量的軟體。所以,如何實施質量保證,是我們關注的主要問題之一,而編碼規範則是實施質量保證的第一步。編碼規範已經成為乙個老生常談的問題,幾乎每個專案,每家公司...

軟體質量保證

一 軟體質量的概念 概括的說 軟體質量就是 軟體與明確地和隱含地定義的要求相一致的程度 具體的說 軟體質量是軟體與明確地敘述的功能和效能需求 文件中明確描述的開發標準以及任何專業開發的軟體產品都應該具有的隱含特性相一致的程度。有3個要點 1 軟體需求是度量軟體質量的基礎,與需求不一致就質量不高。2 ...

軟體質量保證 軟體質量

這篇博文將較為全面深入地談談軟體質量保證中關於軟體質量的概念,內容等相關問題。關於質量的定義,不同的領域,不同的人,不同的側重點會得出截然不同的結果。因此關於其質量的基礎概念相對而言較為好理解,但是具體如何去定義實際上確是無關緊要的。不過我們在分析軟體質量的時候,不僅要考慮其面向使用者的需求覆蓋率,...