提高程式可讀性

2021-10-18 05:40:04 字數 1442 閱讀 3195

在程式設計過程中注意提高程式的可讀性是良好的程式設計習慣,這使程式更易於理解,也更容易在以後進行修改和更正。同時也有助於我們理清自己的程式設計思路。

為了避免步入**的wading,可讀性是必要的。**不僅追求效率,也追求優雅,也即「乾淨利落的抽象」——crisp abstraction(出自grady ,《物件導向分析與設計》作者)

否則可能應了那個程式設計師界的冷笑話:

你剛寫完這個程式的時候,只有你和上帝知道是什麼意思;一年以後,只有上帝知道了。# =.=)

以下是一些能夠在程式設計中有效提高可讀性的手段:

1)有意義的命名

進行名副其實的命名,而不是使用無意義的隨意的名字,這種規則包括但不限於變數名、函式名、類名、檔名…否則毫無章法的名字會是讀到**的人產生疑惑,甚至你自己以後重新檢查**時也會陷入迷茫。

其難處在於需要良好的描述技巧,精準的用詞(尤其是我們對英語的掌握可能不那麼精通的時候)

最基本的是:不要簡單的使用a,b,c,d去命名變數!

2)避免誤導

不要給變數等起乙個可能被人誤導的名字。

譬如不要用 accountlist 來表示乙個賬號,除非它真的是乙個 list,若所用容器不是list,可能會引起一些錯誤的判斷。

還有不要用小寫l, 大寫o直接作名字,因為它們和數字0 1很像==

3)經典命名法

經典命名法介紹

恰到好處的注釋可以省下許多力氣,***

p.s.該技巧與 技巧1 在實際編寫**時應該綜合應用,相得益彰,避免重複囉嗦,要減少不必要的注釋。

1)減少巢狀

多層巢狀會大幅度降低程式的可讀性,我們可以借用函式來減少巢狀

2)避免重複

重複的**塊可能意味著某種想法未在程式中清晰的表達出來,這也削弱了**的可讀性。

利用函式包裝重複**塊,可以使程式更整潔

3)**模組化

當**量比較大時,對**進行模組化,根據各個部分的不同功能進行打包區分,包進函式裡,可以使程式看起來整齊有序,提高可讀性。

利用空行分隔多個部分,使程式的步驟序列一目了然,顯得結構清晰,也便於作者的整理思考

注意良好的縮排格式等;遵守主流**風格,不要另闢蹊徑,

譬如:不要把你的**的幾句放在一行裡或者把一句拆成一行以上!!

int 

num =3;

//case 1

int num =9;

printf

("%d"

, num)

;return0;

//case 2

正如《**整潔之道》一書中的「花時間保持**整潔不但有關效率,還有關生存」,畢竟混亂會導致團隊生產力下降,又製造更多混亂,最終效率趨向於零…

因此,在編碼過程中注意提高程式可讀性就顯得至關重要。not necessary elegant, but always clean and tidy

C 如何提高程式可讀性

程式的可讀性高是乙個程式設計師良好的程式設計習慣的體現。可讀性高可以讓程式設計師更好的理解冗長的 同時也更容易發現錯誤並且修改。不僅如此,在你請求別人對你的程式進行修改時,也能讓別人更好的進行修改工作。否找面對一坨坨的 段,恐怕沒人願意讀下去吧。所以這裡就提供幾個提高程式可讀性的技巧,如果你覺得自己...

為tuple中的元素命名,提高程式的可讀性

定義類似於列舉常量的資料充當索引值 使用collection.nametuple代替傳統的內建tuple 示例 使用索引進行訪問,大大降低了程式的可讀性 stu jim 16,male huizhang0110 foxmail.com print name age gender email form...

如何在元組中的每個元素命名,提高程式可讀性

實際案例 如 學生數量很大為了減小儲存開銷,對每個學生資訊用元組表示 jim 16,male jim gmail.com li 17,male li 163.com lucy 16,female lucy qq.com 通常我們採用索引的方式訪問元組,具體操作如下 coding utf 8 stud...