快速理解一堆程式碼的方法 – 使用 Visual Studio 2013 的 Code Map 程式碼地圖


: 內文提及Visual Studio Ultimate已於 2015/3月改名為 Visual Studio Enterprise

各位夥伴們,

當你剛開始接手別人的程式碼,或是維護前人寫的系統,拿到了一堆程式碼,如何快速了解模組間的關連,幫助你很快進入狀況順利接手呢? 有些程式中連註解都沒有,即使有註解也看不懂,另一種情況是看前人留下的系統文件,但,你確定這些文件有更新嗎? Visual Studio Ultimate 2013 中的 Code Map (程式碼地圖) 功能就是來幫助你解決這些問題! 還有除錯一向是開發人員的痛,Code Map 可用圖形化的方式,了解偵錯的Stack及目前跳到哪裏了,這對除錯的容易性有很大的幫助!

本文簡單說明一下 Code Map,若想學習更多可觀看這影片 – 正確的團隊寫碼標準 – 兼顧開發效率及程式碼品質

延伸閱讀 – 再論 Code Map – 在 Visual Studio 中進行圖形化偵錯,找 Bug 更容易

—————————————————————————————————

1. 圖形化你的程式碼! 看圖說故事,快速了解程式碼。

您可以在 Visual Studio Ultimate 中對應程式碼的關聯性。 當您建立 Code Map 時,它們會出現在程式碼編輯器旁邊。 這可讓您專注於工作,因為當您工作時,您可以看到您的程式碼位於程式碼對應的位置。

Code Map - 對應程式碼中的關聯性

Code Map 會顯示程式碼中的關聯性,並出現在程式碼編輯器旁邊。 綠色箭頭會在程式碼中顯示游標的位置。 您可以在對應上加註解,就和在紙張上加註一樣。

Code Map 有助於避免在大型程式碼基底、不熟悉的程式碼或舊版程式碼當中不知所措。 例如,當您在偵錯時,可能必須查看許多檔案和專案的程式碼。 Code Map 可協助您瀏覽這些程式碼並查看它們之間的關聯性。 您不需要完全記住此程式碼、追蹤檔案或繪製個別的圖表。 如果您必須中斷工作,Code Map 可協助重新整理您正在處理之程式碼的記憶體。

觀看 Code Map 的 Demo : 與 Code Map (Channel 9) 了解複雜的程式碼

使用 Code Map 需求 – 需要使用 Visual Studio Ultimate 2013 版本,才能從程式碼編輯器或從方案總管建立 Code Map。且要分析的方案需為 Visual C# .NET、Visual Basic .NET 或 C++ (有限支援) 的方案。

 

2. 視覺化的偵錯! 快速找到 bug 並修正。

 
假設您處理的繪圖程式有 Bug。 F5 開始偵錯。

復原前一次筆觸] 時,在您繪製下一個線條之前都不會發生任何動作。

Code Map - 重新產生 Bug

Undo 方法開始調查。 您會在PaintCanvas 類別中找到。

Code Map - 尋找程式碼

undo 方法及其關聯性。 undo 方法及其參考的欄位加入至新的 Code Map。 當您建立新的對應時,可能需要一些時間為程式碼編製索引。 這有助於後面的作業更快速執行。

Code Map - 顯示方法和相關欄位

提示

提示加入對應的最後一個項目會以綠色反白顯示。 綠色箭頭顯示指標在程式碼中的位置。 項目之間的箭頭表示不同的關聯性。 您可以藉由檢查對應項目的工具提示取得其相關詳細資訊。

Code Map - 顯示工具提示

F12。 綠色箭頭會在對應中的項目之間移動。 您在程式碼編輯器中的游標也會自動移動。

Code Map - 檢查欄位定義

 

Code Map - 檢查欄位定義

提示

 提示您也可以在程式碼編輯器中移動游標來移動對應上的綠色箭頭。

history 及 paintObjects 欄位互動。 您可以將所有參考這些欄位的方法加入至對應。 您可以從對應或程式碼執行此步驟。

Code Map - 尋找所有參考

  

 變更配置以重新排列關聯性流程,使對應更容易閱讀。 您也可以透過拖曳的方式將項目在對應間移動。

Code Map - 變更版面配置

提示

提示:  累加配置]。 當您加入新項目時,這會盡可能減少重新排列對應。 若要在每次加入新項目時重新排列整個對應,請關閉 [累加配置]。
 

Code Map - 變更版面配置

我們來檢查這些方法。 PaintCanvas] 方法,或選擇此方法並按下 F12。 history 和 paintObjects 建立為空白清單。

Code Map - 檢查方法定義

現在重複相同步驟來檢查 clear 方法定義。 clear 會對 paintObjects 和 history 執行某些工作。 Repaint 方法。

Code Map - 檢查方法定義

現在檢查 addPaintObject 方法定義。 history 和 paintObjects 執行某些工作。 Repaint

Code Map - 檢查方法定義

history 和 paintObjects 的方法都會呼叫 Repaint。 但 undo 方法不會呼叫 Repaint,即使 undo 會修改相同的欄位。 undo 呼叫 Repaint 解決這個問題。

Code Map - 尋找遺漏的方法呼叫

如果您沒有對應顯示這個遺漏的呼叫,可能難以發現這個問題,特別是在較複雜的程式碼中。

在您或其他人修正此 Bug 之前,您可以在對應上記下關於問題和修正方式的附註。

Code Map - 為項目加上註解和旗標以便後續追蹤

例如,您可以使用色彩加入註解至對應和旗標項目。

Code Map - 加上註解和已標幟的項目

如果您有安裝 Microsoft Outlook,您可以用電子郵件將對應傳送給其他人。 您也可以將對應匯出為影像或其他格式。

Code Map - 共用、匯出、寄送郵件

Repaint 的呼叫加入至 undo

Code Map - 加入遺漏的方法呼叫

若要確認您的修正,先重新啟動偵錯工作階段,然後嘗試重現 Bug。 現在選擇 [復原前一次筆觸] 會如您所預期作用,並確認您已進行正確的修正。

Code Map - 確認程式碼修正

您可以更新對應以顯示您所做的修正。

Code Map - 使用遺漏的方法呼叫來更新對應

您的對應現在會在 [復原] 和 [重繪] 之間顯示連結。

Code Map - 已更新且包含方法呼叫的對應


注意事項

當您更新對應時,可能會看到訊息,指出用於建立對應的程式碼索引已更新。 這表示有人變更程式碼,使您的對應與目前的程式碼不符。 這不會阻止您更新對應,不過,您可能必須重新建立對應以確認其符合程式碼。

現在您已完成調查。 您藉由對應程式碼成功找到問題並且加以解決。 您還可以利用對應巡覽程式碼、記住您所學到的內容,以及顯示您用於解決問題的步驟。

Comments (0)

Skip to main content