源代碼是什么

2023年12月11日發(作者：上海游覽)

-

源代碼是什么

源代碼（也稱源程序），是指一系列人類可讀的計算機語言指令。 在現代程序語言中，源代碼可以是以書籍或者磁帶的形式出現，但最為常用的格式是文本文件，這種典型格式的目的是為了編譯出計算機程序。計算機源代碼的最終目的是將人類可讀的文本翻譯成為計算機可以執行的二進制指令，這種過程叫做編譯，通過編譯器完成。

代碼組合

源代碼作為軟件的特殊部分，可能被包含在一個或多個文件中。一個程序不必用同一種格式的源代碼書寫。例如，一個程序如果有C語言庫的支持，那么就可以用C語言；而另一部分為了達到比較高的運行效率，則可以用匯編語言編寫。較為復雜的軟件，一般需要數十種甚至上百種的源代碼的參與。為了降低種復雜度，必須引入一種可以描述各個源代碼之間聯系，并且如何正確編譯的系統。在這樣的背景下，修訂控制系統（RCS）誕生了，并成為研發者對代碼修訂的必備工具之一。還有另外一種組合：源代碼的編寫和編譯分別在不同的平臺上實現，專業術語叫做軟件移植。

質量

對于計算機而言，并不存在真正意義上的“好”的源代碼；然而作為一個人，好的書寫習慣將決定源代碼的好壞。源代碼是否具有可讀性，成為好壞的重要標準。軟件文檔則是表明可讀性的關鍵。

作用

源代碼主要功用有如下2種作用：

生成目標代碼，即計算機可以識別的代碼。

對軟件進行說明，即對軟件的編寫進行說明。為數不少的初學者，甚至少數有經驗的程序員都忽視軟件說明的編寫，因為這部分雖然不會在生成的程序中直接顯示，也不參與編譯。但是說明對軟件的學習、分享、維護和軟件復用都有巨大的好處。因此，書寫軟件說明在業界被認為是能創造優秀程序的良好習慣，一些公司也硬性規定必須書寫。 計算機里面運行的所有東西都是用程序編出來的(包括操作系統,如Windows,還有Word等,網絡游戲也一樣),而編寫程序要用到計算機語言,用計算機語言直接編出來的程序就叫源碼,比如用VisualBasic編寫的源碼文件一般為.bas文件，而用C++編寫的一般為.cpp文件，源代碼不能直接在Windows下運行，必須編譯后才能運行。源碼經過編譯處理后就可以直接在操作系統下運行了。很多的站長都喜歡使用建網站的程序源碼，因為可以很方便的修改，對于任何一個o人員來說，都是非常好的一個切入點。從字面意義上來講,源文件是指一個文件,指源代碼的集合.源代碼則是一組具有特定意義的可以實現特定功能的字符(程序開發代碼)，源代碼”在大多數時候等于“源文件”。比如在這個網頁上右鍵鼠標,選擇查看源文件.出來一個記事本,里面的內容就是此網頁的源代碼."這句話就體現了他們的關系,此處的源文件是指網頁的源文件,而源代碼就是源文件的內容,所以又可以稱做網頁的源代碼..，源代碼是指原始代碼，可以是任何語言代碼。匯編碼是指源代碼編譯后的代碼，通常為二進制文件，比如DLL、EXE、.NET中間代碼、JAVA中間代碼等。高級語言通常指C/C++、BASIC、C#、JAVA、PASCAL、易語言等等。匯編語言就是ASM，只有這個，比這個更低級的就是機器語言了。

網站源碼作為軟件的特殊部分，可能被包含在一個或多個文件中。一個程序不必用同一種格式的源代碼書寫。例如，一個程序如果有C語言庫的支持，那么就可以用C語言；而另一部分為了達到比較高的運行效率，則可以用匯編語言編寫。較為復雜的軟件，一般需要數十種甚至上百種的源代碼的參與。為了降低種復雜度，必須引入一種可以描述各個源代碼之間聯系，并且如何正確編譯的系統。在這樣的背景下，修訂控制系統（RCS）誕生了，并成為研發者對代碼修訂的必備工具之一。還有另外一種組合：源代碼的編寫和編譯分別在不同的平臺上實現，專業術語叫做軟件移植。

閱讀別人的代碼作為開發人員是一件經常要做的事情。一個是學習新的編程語言的時候通過閱讀別人的代碼是一個最好的學習方法，另外是積累編程經驗。如果你有機會閱讀一些操作系統的代碼會幫助你理解一些基本的原理。還有就是在你作為一個質量保證人員或一個小領導的時候如果你要做白盒測試的時候沒有閱讀代碼的能力是不能完成相應的任務。最后一個就是如果你中途接手一個項目的時候或給一個項目做售后服務的時候是要有閱讀代碼的能力的。

收集所有可能收集的材料 閱讀代碼要做的第一件事情是收集所有和項目相關的資料。比如你要做一個項目的售后服務，那么你首先要搞明白項目做什么用的，那么調研文檔、概要設計文檔、詳細設計文檔、測試文檔、使用手冊都是你要最先搞到手的。如果你是為了學習那么盡量收集和你的學習有關的資料，比如你想學習linux的文件系統的代碼，那最好要找到linux的使用手冊、以及文件系統設計的方法、數據結構的說明。(這些資料在書店里都可以找到)。

材料的種類分為幾種類型

1.基礎資料。

比如你閱讀turbo、/ccgx/、c2的源代碼你要有turbo c2的函數手冊，使用手冊等專業書籍，msc 6.0或者java 的話不但要有函數手冊，還要有類庫函數手冊。這些資料都是你的基礎資料。另外你要有一些關于uml的資料可以作為查詢手冊也是一個不錯的選擇

2.和程序相關的專業資料。

每一個程序都是和相關行業相關的。比如我閱讀過一個關于氣象分析方面的代碼，因為里邊用到了一個復雜的數據轉換公式，所以不得不把自己的大學時候課本 找出來來復習一下高等數學的內容。如果你想閱讀linux的文件管理的代碼，那么找一本講解linux文件系統的書對你的幫助會很大。

3.相關項目的文檔資料

這一部分的資料分為兩種，一個相關行業的資料，比如你要閱讀一個稅務系統的代碼那么有一些財務/稅務系統的專業資料和國家的相關的法律、法規的資料是

必不可少的。此外就是關于這個項目的需求分析報告、概要設計報告、詳細設計報告，使用手冊、測試報告等，盡量多收集對你以后的代碼閱讀是很重要的

知識準備

了解基礎知識，不要上來就閱讀代碼，打好基礎可以做到事半功倍的效果

留備份,構造可運行的環境

代碼拿到手之后的第一件事情是先做備份，最好是刻在一個光盤上，在代碼閱讀的時候一點不動代碼是很困難的一件事情，特別是你要做一些修改性或增強性維護的時候。而一旦做修改就可能發生問題，到時候要恢復是經常發生的事情，如果你不能很好的使用版本控制軟件那么先留一個備份是一個最起碼的要求了。

在做完備份之后最好給自己構造一個可運行的環境，當然可能會很麻煩，但可運行代碼和不可運行的代碼閱讀起來難度會差很多的。所以多用一點時間搭建一個環境是很值得的，而且我們閱讀代碼主要是為了修改其中的問題或做移植操作。不能運行的代碼除了可以學到一些技術以外，用處有限。

找開始的地方

做什么事情都要知道從那里開始，讀程序也不例外。在c語言里,首先要找到main()函數，然后逐層去閱讀，其他的程序無論是vb、delphi都要首先找到程序頭，否則你是很難分析清楚程序的層次關系。

分層次閱讀

在閱讀代碼的時候不要一頭就扎下去，這樣往往容易只見樹木不見森林，閱讀代碼比較好的方法有一點象二叉樹的廣度優先的遍歷。在程序主體一般會比較簡

單，調用的函數會比較少，根據函數的名字以及層次關系一般可以確定每一個函數的大致用途，將你的理解作為注解寫在這些函數的邊上。當然很難一次就將全部注 解都寫正確，有時候甚至可能是你猜測的結果，不過沒有關系這些注解在閱讀過程是不斷修正的，直到你全部理解了代碼為止。一般來說采用逐層閱讀的方法可以是 你系統的理解保持在一個正確的方向上。避免一下子扎入到細節的問題上。在分層次閱讀的時候要注意一個問題，就是將系統的函數和開發人員編寫代碼區分開。在 c, c++，java ,delphi中都有自己的系統函數，不要去閱讀這些系統函數，除非你要學習他們的編程方法，否則只會浪費你的時間。將系統函數表示出來，注明它們的作用 即可，區分系統函數和自編函數有幾個方法，一個是系統函數的編程風格一般會比較好，而自編的函數的編程風格一般比較會比較差。從變量名、行之間的縮進、注 解等方面一般可以分辨出來，另外一個是象ms c6++會在你編程的時候給你生成一大堆文件出來，其中有很多文件是你用不到了，可以根據文件名來區分一下時候是系統函數，最后如果你實在確定不了，那就 用開發系統的幫助系統去查一下函數名，對一下參數等來確定即可。

寫注解

寫注解是在閱讀代碼中最重要的一個步驟，在我們閱讀的源代碼一般來說是我們不熟悉的系統,閱讀別人的代碼一般會有幾個問題，1搞明白別人的編程思想不

是一件很容易的事情，即使你知道這段程序的思路的時候也是一樣。2閱讀代碼的時候代碼量一般會比較大，如果不及時寫注解往往會造成讀明白了后邊忘了前邊的 現象。3閱讀代碼的時候難免會出現理解錯誤，如果沒有及時的寫注解很難及時的發現這些錯誤。4不寫注解有時候你發生你很難確定一個函數你時候閱讀過，它的功能是什么，經常會發生重復閱讀、理解的現象。

好了，說一些寫注解的基本方法：1猜測的去寫，剛開始閱讀一個代碼的時候，你很難一下子就確定所有的函數的功能，不妨采用采用猜測的方法去寫注解，根

據函數的名字、位置寫一個大致的注解，當然一般會有錯誤，但你的注解實際是不但調整的，直到最后你理解了全部代碼。2按功能去寫，別把注解寫成語法說明 書，千萬別看到fopen就寫打開文件，看到fread就寫讀數據，這樣的注解一點用處都沒有，而應該寫在此處開發參數配置文件(****。dat)讀出 系統初始化參數。。。。。，這樣才是有用的注解。3在寫注解的使用另外要注意的一個問題是分清楚系統自動生成的代碼和用戶自 己開發的代碼，一般來說沒有必要寫系統自動生成的代碼。象delphi的代碼，我們往往要自己編寫一些自己的代碼段，還要對一些系統自動生成的代碼段進行 修改，這些代碼在閱讀過程是要寫注解的，但有一些沒有修改過的自動生成的代碼就沒有必要寫注解了。4在主要代碼段要寫較為詳細的注解。有一些函數或類在程 序中起關鍵的作用，那么要寫比較詳細的注解。這樣對你理解代碼有很大的幫助。5對你理解起來比較困難的地方要寫詳細的注解，在這些地方往往會有一些編程的技巧。不理解這些編程技巧對你以后的理解或移植會有問題。6寫中文注解。如果你的英文足夠的好，不用看這條了，但很多的人英文實在不怎么樣，那就寫中文注解吧，我們寫注解是為了加快自己的理解速度。中文在大多數的時候比英文更適應中國人。與其寫一些誰也看不懂的英文注解還不如不寫。

重復閱讀

一次就可以將所有的代碼都閱讀明白的人是沒有的。至少我還沒有遇到過。反復的去閱讀同一段代碼有助于得代碼的理解。一般來說，在第一次閱讀代碼的時候

你可以跳過很多一時不明白的代碼段，只寫一些簡單的注解，在以后的重復閱讀過程用，你對代碼的理解會比上一次理解的更深刻，這樣你可以修改那些注解錯誤的 地方和上一次沒有理解的對方。一般來說，對代碼閱讀3，4次基本可以理解代碼的含義和作用。

運行并修改代碼 如果你的代碼是可運行的，那么先讓它運行起來，用單步跟蹤的方法來閱讀代碼，會提高你的代碼速度。代碼通過看中間變量了解代碼的含義,而且對 以后的修改會提供很大的幫助

用自己的代碼代替原有代碼，看效果，但在之前要保留源代碼

600行的一個函數，閱讀起來很困難，編程的人不是一個好的習慣。在閱讀這個代碼的時候將代碼進行修改，變成了14個函數。每一個大約是40-50 行左右.

第一章: 導論

1.要養成一個習慣, 經常花時間閱讀別人編寫的高品質代碼.

2.要有選擇地閱讀代碼, 同時, 還要有自己的目標. 您是想學習新的模式|編碼風格|還是滿足某些需求的方法.

3.要注意并重視代碼中特殊的非功能性需求, 這些需求也許會導致特殊的實現風格.

4.在現有的代碼上工作時, 請與作者和維護人員進行必要的協調, 以避免重復勞動或產生厭惡情緒.

5.請將從開放源碼軟件中得到的益處看作是一項貸款, 盡可能地尋找各種方式來回報開放源碼社團.

6.多數情況下, 如果您想要了解"別人會如何完成這個功能呢?", 除了閱讀代碼以外, 沒有更好的方法.

7.在尋找bug時, 請從問題的表現形式到問題的根源來分析代碼. 不要沿著不相關的路徑(誤入歧途).

8.我們要充分利用調試器|編譯器給出的警告或輸出的符號代碼|系統調用跟蹤器|數據庫結構化查詢語言的日志機制|包轉儲工具和Windows的消息偵查程序, 定出的bug的位置.

9.對于那些大型且組織良好的系統, 您只需要最低限度地了解它的全部功能, 就能夠對它做出修改.

10.當向系統中增加新功能時, 首先的任務就是找到實現類似特性的代碼, 將它作為待實現功能的模板.

11.從特性的功能描述到代碼的實現, 可以按照字符串消息, 或使用關鍵詞來搜索代碼. 12.在移植代碼或修改接口時, 您可以通過編譯器直接定位出問題涉及的范圍, 從而減少代碼閱讀的工作量.

13.進行重構時, 您從一個能夠正常工作的系統開始做起, 希望確保結束時系統能夠正常工作. 一套恰當的測試用例(test ca)可以幫助您滿足此項約束.

14.閱讀代碼尋找重構機會時, 先從系統的構架開始, 然后逐步細化, 能夠獲得最大的效益.

15.代碼的可重用性是一個很誘人, 但難以理解與分離, 可以試著尋找粒度更大一些的包, 甚至其他代碼.

16.在復查軟件系統時, 要注意, 系統是由很多部分組成的, 不僅僅只是執行語句. 還要注意分析以下內容: 文件和目錄結構|生成和配置過程,用戶界面和系統的文檔.

18.可以將軟件復查作為一個學習|講授|援之以手和接受幫助的機會.

++++++++++++++++++++

第二章: 基本編程元素

++++++++++++++++++++

19.第一次分析一個程序時, main是一個好的起始點.

20.層疊-el序列可以看作是由互斥選擇項組成的選擇結構.

21.有時, 要想了解程序在某一方面的功能, 運行它可能比閱讀源代碼更為恰當.

22.在分析重要的程序時, 最好首先識別出重要的組成部分.

23.了解局部的命名約定, 利用它們來猜測變量和函數的功能用途.

24.當基于猜測修改代碼時, 您應該設計能夠驗證最初假設的過程. 這個過程可能包括用編譯器進行檢查|引入斷言|或者執行適當的測試用例.

25.理解了代碼的某一部分, 可能幫助你理解余下的代碼.

26.解決困難的代碼要從容易的部分入手.

27.要養成遇到庫元素就去閱讀相關文檔的習慣; 這將會增強您閱讀和編寫代碼的能力.

28.代碼閱讀有許多可選擇的策略: 自底向上和自頂向下的分析|應用試探法和檢查注釋和外部文檔, 應該依據問題的需要嘗試所有這些方法.

(i=0; i

30.涉及兩項不等測試(其中一項包括相等條件)的比較表達式可以看作是區間成員測試.

31.我們經常可以將表達式應用在樣本數據上, 借以了解它的含義.

32.使用De Morgan法則簡化復雜的邏輯表達式.

33.在閱讀邏輯乘表達式時, 問題可以認為正在分析的表達式以左的表達式均為true; 在閱讀邏輯和表達式時, 類似地, 可以認為正在分析的表達式以左的表達式均為fal.

34.重新組織您控制的代碼, 使之更為易讀.

35.將使用條件運行符? :的表達式理解為if代碼.

36.不需要為了效率, 犧牲代碼的易讀性.

37.高效的算法和特殊的優化確實有可能使得代碼更為復雜, 從而更難理解, 但這并不意味著使代碼更為緊湊和不易讀會提高它的效率.

38.創造性的代碼布局可以用來提高代碼的易讀性.

39.我們可以使用空格|臨時變量和括號提高表達式的易讀性.

40.在閱讀您所控制的代碼時, 要養成添加注釋的習慣.

41.我們可以用好的縮進以及對變量名稱的明智選擇, 提高編寫欠佳的程序的易讀性.

42.用diff程序分析程序的修訂歷史時, 如果這段歷史跨越了整體重新縮排, 常常可以通過指定-w選項, 讓diff忽略空白差異, 避免由于更改了縮進層次而引入的噪音.

循環的循環體至少執行一次.

44.執行算術運算時, 當b=2n-1時, 可以將a&b理解為a%(b+1).

45.將a<

46.將a>>n理解為a/k, k=2n. 47.每次只分析一個控制結構, 將它的內容看作是一個黑盒.

48.將每個控制結構的控制表達式看作是它所包含代碼的斷言.

, goto, break和continue語句, 還有異常, 都會影響結構化的執行流程. 由于這些語句一般都會終止或重新開始正在進行的循環,因此要單獨推理它們的行為.

50.用復雜循環的變式和不變式, 對循環進行推理.

51.使用保持含義不變的變換重新安排代碼, 簡化代碼的推理工作.

+++++++++++++++++++

第三章: 高級C數據類型

+++++++++++++++++++

52.了解特定語言構造所服務的功能之后, 就能夠更好地理解使用它們的代碼.

53.識別并歸類使用指針的理由.

54.在C程序中, 指針一般用來構造鏈式數據結構|動態分配的數據結構|實現引用調用|訪問和迭代數據元素|傳遞數組參數|引用函數|作為其他值的別名|代表字符串|以及直接訪問系統內存.

55.以引用傳遞的參數可以用來返回函數的結果, 或者避免參數復制帶來的開銷.

56.指向數組元素地址的指針, 可以訪問位于特定索引位置的元素.

57.指向數組元素的指針和相應的數組索引, 作用在二者上的運算具有相同的語義.

58.使用全局或static局部變量的函數大多數情況都不可重入(reentrant).

59.字符指針不同于字符數組.

60.識別和歸類應用結構或共用體的每種理由.

61.C語言中的結構將多個數據元素集合在一起, 使得它們可以作為一個整體來使用, 用來從函數中返回多個數據元素|構造鏈式數據結構|映射數據在硬件設備|網絡鏈接和存儲介質上的組織方式|實現抽象數據類型|以及以面向對象的方式編程.

62.共用體在C程序中主要用于優化存儲空間的利用|實現多態|以及訪問數據不同的內部表達方式.

63.一個指針, 在初始化為指向N個元素的存儲空間之后, 就可以作為N個元素的數組來使用.

64.動態分配的內在塊可以電焊工地釋放, 或在程序結束時釋放, 或由垃圾回收器來完成回收; 在棧上分配的內存塊當分配它的函數退出后釋放

65.C程序使用typedef聲明促進抽象, 并增強代碼的易讀性, 從而防范可移植性問題, 并模擬C++和Java的類聲明行為.

66.可以將typedef聲明理解成變量定義: 變量的名稱就是類型的名稱; 變量的類型就是與該名稱對應的類型.

+++++++++++++++

第四章: C數據結構

+++++++++++++++

67.根據底層的抽象數據類型理解顯式的數據結構操作.

68.C語言中, 一般使用內建的數組類型實現向量, 不再對底層實現進行抽象.

69.N個元素的數組可以被序列for (i=0; i

70.表達式sizeof(x)總會得到用memt或memcpy處理數組x(不是指針)所需的正確字節數.

71.區間一般用區間內的第一個元素和區間后的第一個元素來表示.

72.不對稱區間中元素的數目等于高位邊界與低位邊界的差.

73.當不對稱區間的高位邊界等于低位邊界時, 區間為空.

74.不對稱區間中的低位邊界代表區間的第一個元素; 高位邊界代表區間外的第一個元素.

75.結構的數組常常表示由記錄和字段組成的表.

76.指向結構的指針常常表示訪問底層記錄和字段的游標.

77.動態分配的矩陣一般存儲為指向數組列的指針或指向元素指針的指針; 這兩種類型都可以按照二維數組進行訪問.

78.以數組形式存儲的動態分配矩陣, 用自定義訪問函數定位它們的元素.

79.抽象數據類型為底層實現元素的使用(或誤用)方式提供一種信心的量度.

80.數組用從0開始的順序整數為鍵, 組織查找表.

81.數組經常用來對控制結構進行高效編碼, 簡化程序的邏輯.

82.通過在數組中每個位置存儲一個數據元素和一個函數指針(指向處理數據元素的函數), 可以將代碼與數據關聯起來.

83.數組可以通過存儲供程序內的抽象機(abstract machine)或虛擬機(virtual machine)使用的數據或代碼, 控制程序的運作.

84.可以將表達式sizeof(x) / sizeof(x[0])理解為數組x中元素的個數.

85.如果結構中含有指向結構自身|名為next的元素, 一般說來, 該結構定義的是單向鏈表的結點.

86.指向鏈表結點的持久性(如全局|靜態或在堆上分配)指針常常表示鏈表的頭部.

87.包含指向自身的next和prev指針的結構可能是雙向鏈表的結點.

88.理解復雜數據結構的指針操作可以將數據元素畫為方框|指針畫為箭頭.

89.遞歸數據結構經常用遞歸算法來處理.

90.重要的數據結構操作算法一般用函數參數或模板參數來參數化.

91.圖的結點常常順序地存儲在數組中, 鏈接到鏈表中, 或通過圖的邊鏈接起來.

92.圖中的邊一般不是隱式地通過指針, 就是顯式地作為獨立的結構來表示.

93.圖的邊經常存儲為動態分配的數組或鏈表, 在這兩種情況下, 邊都錨定在圖的結點上.

94.在無向圖中, 表達數據時應該將所有的結點看作是等同的, 類似地, 進行處理任務的代碼也不應該基于它們的方向來區分邊.

95.在非連通圖中, 執行遍歷代碼應該能夠接通孤立的子圖.

96.處理包含回路的圖時, 遍歷代碼應該避免在處理圖的回路進入循環.

97.復雜的圖結構中, 可能隱藏著其他類型的獨立結構.

+++++++++++++++++

第五章: 高級控制流程

+++++++++++++++++

98.采用遞歸定義的算法和數據結構經常用遞歸的函數定義來實現.

99.推理遞歸函數時, 要從基準落伍測試開始, 并認證每次遞歸調用如何逐漸接近非遞歸基準范例代碼.

100.簡單的語言常常使用一系列遵循該語言語法結構的函數進行語法分析.

101.推理互遞歸函數時, 要基于底層概念的遞歸定義.

102.尾遞歸調用等同于一個回到函數開始處的循環.

103.將throws子句從方法的定義中移除, 然后運行Java編譯器對類的源代碼進行編譯, 就可以容易地找到那些可能隱式地生成異常的方法.

104.在多處理器計算機上運行的代碼常常圍繞進程或線程進行組織.

105.工作群并行模型用于在多個處理器間分配工作, 或者創建一個任務池, 然后將大量需要處理標準化的工作進行分配.

106.基于線程的管理者/工人并行模型一般將耗時的或阻塞的操作分配給工人子任務, 從而維護中心任務的響應性.

107.基于進程的管理者/工人并行模型一般用來重用現有的程序, 或用定義良好的接口組織和分離粗粒度的系統模塊.

108.基于流水線的并行處理中, 每個任務都接收到一些輸入, 對它們進行一些處理, 并將生成的輸出傳遞給下一個任務, 進行不同的處理.

109.競爭條件很難捉摸, 相關的代碼常常會將競爭條件擴散到多個函數或模塊; 因而, 很難隔離由于競爭條件導致的問題.

110.對于出現在信號處理器中的數據結構操作代碼和庫調用要保持高度警惕.

111.在閱讀包含宏的代碼時, 要注意, 宏既非函數, 也非語句.

…while(0)塊中的宏等同于控制塊中的語句.

113.宏可以訪問在它的使用點可見的所有局部變量.

114.宏調用可改變參數的值

115.基于宏的標記拼接能夠創建新的標記符.

+++++++++++++++++

第六章: 應對大型項目

+++++++++++++++++

116.我們可以通過瀏覽項目的源代碼樹—包含項目源代碼的層次目錄結構, 來分析一個項目的組織方式. 源碼樹常常能夠反映出項目在構架和軟件過程上的結構.

117.應用程序的源代碼樹經常是該應用程序的部署結構的鏡像.

118.不要被龐大的源代碼集合嚇倒; 它們一般比小型的專門項目組織得更出色.

119.當您首次接觸一個大型項目時, 要花一些時間來熟悉項目的目錄樹結構.

120.項目的源代碼遠不只是編譯后可以獲得可執行程序的計算機語言指令; 一個項目的源碼樹一般還包括規格說明|最終用戶和開發人員文檔|

測試腳本|多媒體資源|編譯工具|例子|本地化文件|修訂歷史|安裝過程和許可信息.

121.大型項目的編譯過程一般聲明性地借助依賴關系來說明. 依賴關系由工具程序, 如make及其派生程序, 轉換成具體的編譯行動.

122.大型項目中, 制作文件常常由配置步驟動態地生成; 在分析制作文件之前, 需要先執行項目特定的配置.

123.檢查大型編譯過程的各個步驟時, 可以使用make程序的-n開關進行預演.

124.修訂控制系統提供從儲存庫中獲取源代碼最新版本的方式.

125.可以使用相關的命令, 顯示可執行文件中的修訂標識關鍵字, 從而將可執行文件與它的源代碼匹配起來.

126.使用修訂日志中出現的bug跟蹤系統內的編號, 可以在bug跟蹤系統的數據庫中找到有關的問題的說明.

127.可以使用修訂控制系統的版本儲存庫, 找出特定的變更是如何實現的.

128.定制編譯工具用在軟件開發過程的許多方面, 包括配置|編譯過程管理|代碼的生成|測試和文檔編制.

129.程序的調試輸出可以幫助我們理解程序控制流程和數據元素的關鍵部分.

130.跟蹤語句所在的地點一般也是算法運行的重要部分.

131.可以用斷言來檢驗算法運作的步驟|函數接收的參數|程序的控制流程|底層硬件的屬性和測試用例的結果.

132.可以使用對算法進行檢驗的斷言來證實您對算法運作的理解, 或將它作為推理的起點.

133.對函數參數和結果的斷言經常記錄了函數的前置條件和后置條件.

134.我們可以將測試整個函數的斷言作為每個給定函數的規格說明.

135.測試用例可以部分地代替函數規格說明.

136.可以使用測試用例的輸入數據對源代碼序列進行預演.

+++++++++++++++++++

第七章: 編碼規范和約定

+++++++++++++++++++

137.了解了給定代碼庫所遵循的文件組織方式后, 就能更有效率地瀏覽它的源代碼.

138.閱讀代碼時, 首先要確保您的編輯器或優美打印程序的tab設置, 與代碼遵循的風格規范一致.

139.可以使用代碼塊的縮進, 快速地掌握代碼的總體結構.

140.對編排不一致的代碼, 應該立即給予足夠的警惕.

141.分析代碼時, 對標記為XXX, FIXME和TODO的代碼序列要格外注意: 錯誤可能就潛伏在其中. 142.常量使用大寫字母命名, 單詞用下劃線分隔.

143.在遵循Java編碼規范的程序中, 包名(package name)總是從一個頂級的域名開始(例如, org, com), 類名和接口名由大寫字母開始, 方法和變量名由小寫字母開始.

144.用戶界面控件名稱之前的匈牙利記法的前綴類型標記可以幫助我們確定它的作用.

145.不同的編程規范對可移植構造的構成有不同的主張.

146.在審查代碼的可移植性, 或以某種給定的編碼規范作為指南時, 要注意了解規范對可移植性需求的界定與限制.

147.如果GUI功能都使用相應的編程結構來實現, 則通過代碼審查可以輕易地驗證給定用戶界面的規格說明是否被正確地采用.

148.了解項目編譯過程的組織方式與自動化方式之后, 我們就能夠快速地閱讀與理解對應的編譯規則.

149.當檢查系統的發布過程時, 常常可以將相應發行格式的需求作為基準.

++++++++++++

第八章： 文檔

++++++++++++

150.閱讀代碼時, 應該盡可能地利用任何能夠得到的文檔.

151.閱讀一小時代碼所得到的信息只不過相當于閱讀一分鐘文檔.

152.使用系統的規格說明文檔, 了解所閱讀代碼的運行環境.

153.軟件需求規格說明是閱讀和評估代碼的基準.

154.可以將系統的設計規格說明作為認知代碼結構的路線圖, 閱讀具體代碼的指引.

155.測試規格說明文檔為我們提供可以用來對代碼進行預演的數據.

156.在接觸一個未知系統時, 功能性的描述和用戶指南可以提供重要的背景信息,從而更好地理解閱讀的代碼所處的上下文.

157.從用戶參考手冊中, 我們可以快速地獲取, 應用程序在外觀與邏輯上的背景知識, 從管理員手冊中可以得知代碼的接口|文件格式和錯誤消息的詳細信息.

158.利用文檔可以快捷地獲取系統的概況, 了解提供特定特性的代碼.

159.文檔經常能夠反映和提示出系統的底層結構.

160.文檔有助于理解復雜的算法和數據結構.

161.算法的文字描述能夠使不透明(晦澀, 難以理解)的代碼變得可以理解.

162.文檔常常能夠闡明源代碼中標識符的含義.

163.文檔能夠提供非功能性需求背后的理論基礎.

164.文檔還會說明內部編程接口.

165.由于文檔很少像實際的程序代碼那樣進行測試, 并受人關注, 所以它常常可能存在錯誤|不完整或過時.

166.文檔也提供測試用例, 以及實際應用的例子.

167.文檔常常還會包括已知的實現問題或bug.

168.環境中已知的缺點一般都會記錄在源代碼中.

169.文檔的變更能夠標出那些故障點.

170.對同一段源代碼重復或互相沖突的更改, 常常表示存在根本性的設計缺陷, 從而使得維護人員需要用一系列的修補程序來修復.

171.相似的修復應用到源代碼的不同部分, 常常表示一種易犯的錯誤或疏忽, 它們同樣可能會在其他地方存在.

172.文檔常常會提供不恰當的信息, 誤導我們對源代碼的理解.

173.要警惕那些未歸檔的特性: 將每個實例歸類為合理|疏忽或有害, 相應地決定是否應該修復代碼或文檔.

174.有時, 文檔在描述系統時, 并非按照已完成的實現, 而是系統應該的樣子或將來的實現.

175.在源代碼文檔中, 單詞gork的意思一般是指”理解”.

176.如果未知的或特殊用法的單詞阻礙了對代碼的理解, 可以試著在文檔的術語表(如果存在的話)|New Hacker’s Dictionary[Ray96]|或在

Web搜索引擎中查找它們.

177.總是要以批判的態度來看待文檔, 注意非傳統的來源, 比如注釋|標準|出版物|測試用例|郵件列表|新聞組|修訂日志|問題跟蹤數據庫|營銷材料|源代碼本身.

178.總是要以批判的態度來看待文檔; 由于文檔永遠不會執行, 對文檔的測試和正式復查也很少達到對代碼的同樣水平, 所以文檔常常會誤導讀者, 或者完全錯誤.

179.對于那些有缺陷的代碼, 我們可以從中推斷出它的真實意圖.

180.在閱讀大型系統的文檔時, 首先要熟悉文檔的總體結構和約定.

181.在對付體積龐大的文檔時, 可以使用工具, 或將文本輸出到高品質輸出設備上, 比如激光打印機, 來提高閱讀的效率.

++++++++++++++

第九章: 系統構架

++++++++++++++

182.一個系統可以(在重大的系統中也確實如此)同時出多種不同的構架類型. 以不同的方式檢查同一系統|分析系統的不同部分|或使用不同級別的分解, 都有可能發現不同的構架類型.

183.協同式的應用程序, 或者需要協同訪問共享信息或資源的半自治進程, 一般會采用集中式儲存庫構架.

184.黑板系統使用集中式的儲存庫, 存儲非結構化的鍵/值對, 作為大量不同代碼元件之間的通信集線器.

185.當處理過程可以建模|設計和實現成一系列的數據變換時, 常常會使用數據流(或管道—過濾器)構架.

186.在批量進行自動數據處理的環境中, 經常會采用數據流構架, 在對數據工具提供大量支持的平臺上尤其如此.

187.數據流構架的一個明顯征兆是: 程序中使用臨時文件或流水線(pipeline)在不同進程間進行通信. 188.使用圖示來建模面向對象構架中類的關系.

189.可以將源代碼輸入到建模工具中, 逆向推導出系統的構架.

190.擁有大量同級子系統的系統, 常常按照分層構架進行組織.

191.分層構架一般通過堆疊擁有標準化接口的軟件組件來實現.

192.系統中每個層可以將下面的層看作抽象實體, 并且(只要該層滿足它的需求說明)不關心上面的層如何使用它.

193.層的接口既可以是支持特定概念的互補函數族, 也可以是一系列支持同一抽象接口不同底層實現的可互換函數.

194.用C語言實現的系統, 常常用函數指針的數組, 表達層接口的多路復用操作.

195.用面向對象的語言實現的系統, 使用虛方法調用直接表達對層接口的多嘴復用操作.

196.系統可以使用不同的|獨特的層次分解模型跨各種坐標軸進行組織.

197.使用程序切片技術, 可以將程序中的數據和控制之間依賴關系集中到一起.

198.在并發系統中, 一個單獨的系統組件起到集中式管理器的作用, 負責啟動|停止和協調其他系統進程和任務的執行.

199.許多現實的系統都會博采眾家之長. 當處理此類系統時, 不要徒勞地尋找無所不包的構架圖; 應該將不同構架風格作為獨立但相關的實體來進行定位|識別并了解.

200.狀態變遷圖常常有助于理清狀態機的動作.

201.在處理大量的代碼時, 了解將代碼分解成單獨單元的機制極為重要.

202.大多數情況下, 模塊的物理邊界是單個文件|組織到一個目錄中的多個文件或擁有統一前綴的文件的集合.

203.C中的模塊, 由提供模塊公開接口的頭文件和提供對應實現的源文件組成.

204.對象的構造函數經常用來分配與對象相關的資源, 并初始化對象的狀態. 函數一般用來釋放對象在生命期中占用的資源.

205.對象方法經常使用類字段來存儲控制所有方法運作的數據(比如查找表或字典)或維護類運作的狀態信息(例如, 賦給每個對象一個標識符的計數器).

206.在設計良好的類中, 所有的字段都應在聲明為private, 并用公開的訪問方法提供對它們的訪問.

207.在遇到friend聲明時, 要停下來分析一下, 看看繞過類封裝在設計上的理由.

208.可以有節制地用運算符增強特定類的可用性, 但用運算符重載, 將類實現為擁有內建算術類型相關的全部功能的類實體, 是不恰當的.

209.泛型實現不是在編譯期間通過宏替換或語言所支持的功能(比如C++模板和Ada的泛型包)來實現, 就是在運行期間通過使用數據元素的指針和函數的指針|或對象的多態性實現.

210.抽象數據類型經常用來封裝常用的數據組織方案(比如樹|列表或棧), 或者對用戶隱藏數據類型的實現細節.

211.使用庫的目的多種多樣: 重用源代碼或目標代碼, 組織模塊集合, 組織和優化編譯過程, 或是用來實現應用程序各種特性的按需載入.

212.大型的|分布式的系統經常實現為許多互相協作的進程.

213.對于基于文本的數據儲存庫, 可以通過瀏覽存儲在其中的數據, 破譯出它的結構.

214.可以通過查詢數據字典中的表, 或使用數據庫專有的SQL命令, 比如show table, 來分析關系型數據庫的模式.

215.識別出重用的構架元素后, 可以查找其最初的描述, 了解正確地使用這種構架的方式, 以及可能出現的誤用.

216.要詳細分析建立在某種框架之上的應用程序, 行動的最佳路線就是從研究框架自身開始.

217.在閱讀向導生成的代碼時, 不要期望太高, 否則您會感到失望.

218.學習幾個基本的設計模式之后, 您會發現, 您查看代碼構架的方式會發生改變: 您的視野和詞匯將會擴展到能夠識別和描述許多通用的形式.

219.頻繁使用的一些模式, 但并不顯式地指出它們的名稱, 這是由于構架性設計的重用經常先于模式的形成.

220.請試著按照底層模式來理解構架, 即使代碼中并沒有明確地提及模式.

221.大多數解釋器都遵循類似的處理構架, 圍繞一個狀態機進行構建, 狀態機的操作依賴于解釋器的當前狀態|程序指令和程序狀態.

222.多數情況下, 參考構架只是為應用程序域指定一種概念性的結構, 具體的實現并非必須遵照這種結構.

+++++++++++++++++

第十章: 代碼閱讀工具

+++++++++++++++++

223.詞匯工具可以高效地在一個大代碼文件中或者跨多個文件查找某種模式.

224.使用程序編輯器和正則表達式查找命令, 瀏覽龐大的源代碼文件.

225.以只讀方式瀏覽源代碼文件.

226.使用正則表達式 ^function name 可以找出函數的定義.

227.使用正則表達式的字符類, 可以查找名稱遵循特定模式的變量.

228.使用正則表達式的否定字符類, 可以避免非積極匹配.

229.使用正則表達式 symbol-1. *symbol-2, 可以查找出現在同一行的符號.

230.使用編輯器的 tags 功能, 可以快速地找出實體的定義.

231.可以用特定的 tag 創建工具, 增加編輯器的瀏覽功能.

232.使用編輯器的大綱視圖, 可以獲得源代碼結構的鳥瞰圖.

233.使用您的編輯器來檢測源代碼中圓括號|方括號和花括號的匹配.

234.使用 grep 跨多個文件查找代碼模式.

235.使用 grep 定位符號的聲明|定義和應用.

236.當您不能精確地表述要查找的內容時, 請使用關鍵單詞的詞干對程序的源代碼進行查找.

237.用 grep 過濾其他工具生成的輸出, 分離出您要查找的項.

238.將 grep 的輸出輸送到其他工具, 使復雜處理任務自動化.

239.通過對 grep 的輸出進行流編輯, 重用代碼查找的結果.

240.通過選取與噪音模式不匹配的輸出行(grep-v), 過濾虛假的 grep 輸出.

241.使用 fgrep 在源代碼中查找字符串列表.

242.查找注釋, 或標識符大小寫不敏感的語言編寫的代碼時, 要使用大小寫不敏感的模式匹配(grep -i).

243.使用 grep –n 命令行開關, 可以創建與給定正則表達式匹配的文件和行號的檢查表.

244.可以使用 diff 比較文件或程序不同版本之間的差別.

245.在運行 diff 命令時, 可以使用 diff –b, 使文件比較算法忽略結尾的空格, 用 –w 忽略所有空白區域的差異, 用 –i 使文件比較對大小寫不敏感.

246.不要對創建自己的代碼閱讀工具心存畏懼.

247.在構建自己的代碼閱讀工具時: 要充分利用現代快速原型語言所提供的能力; 從簡單開始, 根據需要逐漸改進; 使用利用代碼詞匯結構的

各種試探法; 要允許一些輸出噪音或寂靜(無關輸出或缺失輸出); 使用其他工具對輸入進行預處理, 或者對輸出進行后期處理.

248.要使編譯器成為您的: 指定恰當級別的編譯器警告, 并小心地評估生成的結果.

249.使用C預處理器理清那些濫用預處理器特性的程序.

250.要徹底地了解編譯器如何處理特定的代碼塊, 需要查看生成的符號(匯編)代碼.

251.通過分析相應目標文件中的符號, 可以清晰地了解源文件的輸入和輸出.

252.使用源代碼瀏覽器瀏覽大型的代碼集合以及對象類型.

253.要抵制住按照您的編碼規范對外部代碼進行美化的誘惑; 不必要的編排更改會創建不同的代碼, 并妨礙工作的組織.

254.優美打印程序和編輯器語法著色可以使得程序的源代碼為易讀.

程序可以將難以理解的C和C++類型聲明轉換成純英語(反之亦然).

256.實際運行程序, 往往可以更深刻地理解程序的動作.

257.系統調用|事件和數據包跟蹤程序可以增進對程序動作的理解.

258.執行剖析器可以找出需要著重優化的代碼, 驗證輸入數據的覆蓋性, 以及分析算法的動作.

259.通過檢查從未執行的代碼行, 可以找出測試覆蓋的弱點, 并據此修正測試數據.

260.要探究程序動態動作時的每個細節, 需要在調試器中運作它.

261.將您覺得難以理解的代碼打印到紙上.

262.可以繪制圖示來描繪代碼的動作.

263.可以試著向別人介紹您在閱讀的代碼, 這樣做一般會增進您對代碼的理解.

264.理解復雜的算法或巧妙的數據結構, 要選擇一個安靜的環境, 然后聚精會神地考慮, 不要借助于任何計算機化或自動化的幫助.

+++++++++++++++++++++

第十一章: 一個完整的例子

+++++++++++++++++++++

265.模仿軟件的功能時, 要依照相似實體的線路(類|函數|模塊). 在相似的現有實體中, 為簡化對源代碼庫的文本查找, 應選取比較罕見的名稱.

266.自動生成的文件常常會在文件的開關有一段注釋, 說明這種情況.

267.如果試圖精確地分析代碼, 一般會陷入數量眾多的類|文件和模塊中, 這些內容會很快將我們淹沒; 因此, 我們必須將需要理解的代碼限定在絕對必需的范圍之內.

268.采用一種廣度優先查找策略, 從多方攻克代碼閱讀中存在的問題, 進到找出克服它們的方法為止.

-