如何編寫僞代碼

目錄

部分1：理解僞代碼的基本概念

1、瞭解什麼是僞代碼。僞代碼用來對代碼進行逐步描述，並且可以逐漸地將其轉化爲編程語言。很多程序員在編寫技術要求較高的代碼之前，都會使用僞代碼來規劃算法的功能。

僞代碼是一種非正式的指南，一種用來思考程序問題的工具，也是一種有助於你和其他人交流想法的方式。

2、理解僞代碼爲什麼有用。僞代碼用來展示算法應該如何工作。程序員通常使用僞代碼作爲編程的中間步驟，介於初始規劃階段和編寫實際可執行代碼階段之間。僞代碼的其他一些用途包括：描述算法應當如何工作。僞代碼可以說明程序中在哪裏可以或必需使用特定架構、機制或技術。

向非技術用戶解釋處理流程。計算機需要非常嚴格的輸入語法來執行程序，但是普通人（尤其是非程序員）可能會覺得更流暢、更主觀的語言更容易理解，這種語言會清楚地說明每一行代碼的目的。

在團隊環境下設計代碼。進階軟件架構師通常會在設計中包含僞代碼，幫助程序員解決遇到的複雜問題。如果你和其他程序員一起開發程序，你會發現僞代碼有助於明確你的目的。

3、記住，僞代碼是主觀且不標準的。僞代碼未必要使用某一套語法，但是使用標準僞代碼結構會讓其他程序員更容易理解，這是一種常見的行業規範。如果你自己編寫一個項目，最重要的是僞代碼可以幫助你組織思路，並制定計劃。如果你和其他人一起開發項目——無論他們是你的同事、初級程序員還是非技術合作夥伴，至少要使用一些標準結構是很重要的，這樣其他人就可以很容易地理解你的目的。

如果你參加了大學、編程訓練營或一家公司的編程課程，可能會接受僞代碼“標準”的測試。這種標準在不同機構和老師之間經常有所不同。

僞代碼的主要目標就是清晰明瞭，如果你遵循既定的編程規範，僞代碼可能會對你有所幫助。隨着你把僞代碼變成實際代碼時，你會需要將它轉換成一種編程語言——因此僞代碼有助於你構建代碼綱要。

4、專注於僞代碼的主要目的。當你寫僞代碼時，很容易就寫成了代碼。記住僞代碼的目的——解釋程序的每一行應該做什麼——這樣才能讓你在創建僞代碼文檔時保持清醒。

部分2：寫好僞代碼

1、使用純文字編輯器。雖然你可能忍不住使用文字處理程序（如Microsoft word）或類似程序來創建富文1本文檔，但是僞代碼需要儘量減少格式來保持簡潔。

純文字編輯器包括記事本（Windows）和TextEdit（Mac）。

2、首先寫下這個流程的目的。用一兩行來解釋代碼的用途將有助於建立文檔的其餘部分，而且還可以不用向每個閱讀僞代碼的人解釋程序的功能。

3、每行只寫一條語句。僞代碼中的每個語句應該只表示計算機的一個操作。在大多數情況下，如果合理編寫了任務列表，那麼每個任務對應一行僞代碼。考慮寫出任務列表，然後將這個列表轉換爲僞代碼，再逐漸將該僞代碼轉變爲實際的、計算機可讀的代碼。

4、有效使用空白和縮進。在文字的“塊”之間使用空格有助於隔離僞代碼的不同部分，而對每個塊的不同部分進行縮進表明這些僞代碼屬於縮進較少代碼段。例如，關於輸入數字的僞代碼部分應該都在同一個“塊”中，而下一部分（例如，關於輸出的部分）應該在不同的塊中。

5、必要時大寫關鍵指令。根據僞代碼需求或發佈僞代碼的環境，可能需要將實際代碼中保留的指令大寫。例如，你在僞代碼中使用“if”和“then”指令，你最好將它們改爲“IF”和“THEN”（例如，“IF輸入數字THEN輸出結果”）。

6、使用簡單的術語。記住，你寫的是項目將要做什麼，而不是總結代碼本身。如果你編寫僞代碼是爲了向不懂編程的客戶提供演示，或者作爲面向初學者的項目，那麼這一點尤其重要。

你甚至可能想完全不用任何編程指令，而是用通俗易懂的語言來定義每一行的流程。例如，“如果輸入是奇數，輸出‘Y’”可以寫成“如果用戶輸入一個奇數，則顯示‘Y’”。

7、保持僞代碼的合理順序。雖然用於修飾僞代碼的語言應當保持簡潔，但仍然需要按照代碼執行的順序來保持僞代碼每個部分的順序。

8、所有事物都要描述清楚。必須要完整地描述流程中發生的一切。僞代碼語句類似於簡單的英語語句。僞代碼通常不使用變量，而是描述程序應該如何處理接近真實世界的對象，如帳號、名稱或交易額。

9、使用標準編程結構。即使僞代碼沒有標準，如果使用現有編程（順序程序設計）語言的結構，其他程序員也更容易理解你的步驟。使用“if”、“then”、“while”、“else”和“loop”等術語，和你用的編程語言中的使用方式相同。考慮以下結構：if“條件”then“指令”——意思是給定的指令只有在給定的條件爲真時纔會執行。在本例中，“指令”是指程序將執行的步驟，而“條件”是指在執行程序之前，數據必須滿足的一組特定標準。

while“條件”do“指令”——意思是該指令應該一遍又一遍地重複，直到條件不再爲真。

do“條件”while條件——這個結構和“while“條件”do“指令””結構很相似。在第一種情況下，執行指令前會檢查條件，但是在第二種情況下，指令會先執行；因此，在第二種情況下，指令將至少執行一次。

函數名（參數）：指令——意思是每次在代碼中使用某個名稱時，它都是某個指令的縮寫。“參數”是可以用來解釋說明指令的變量列表。

10、整理僞代碼部分。如果你有大量的僞代碼，這些代碼定義同一塊中的其他僞代碼片段，那你最好使用方括號或其他標識符來包含所有內容。括號——標準方括號（例如，[code]）和大括號（例如，{code}）都可以用來包含大段僞代碼。

編程時，可以透過在註釋左側輸入“//”來添加註釋（例如，//這是一個臨時步驟）。在編寫僞代碼時，你也可以使用同樣的方法，把那些不適合放到編碼文字裏的內容作爲註釋寫下來。

11、仔細檢查僞代碼的可讀性和清晰度。讀完全文後你應該可以回答下列問題：不熟悉這個流程的人能理解這個僞代碼嗎？

僞代碼的編寫方式是否便於將其轉換爲計算語言?

僞代碼是否描述了整個流程而沒有任何遺漏?

僞代碼中使用的每個對象名稱都能被目標讀者清楚地理解嗎?

如果你發現僞代碼的某個部分需要詳細闡述，或者它沒有明確地列出其他人可能會忘記的步驟，那麼你應該返回這個部分並添加必要的資訊。

部分3：創建僞代碼文檔示例

1、開啟純文字編輯器。如果不想安裝新程序，可以使用默認程序，即“記事本” （Windows）或TextEdit（Mac）。

2、定義程序。雖然不是必須的，但是在文檔頂部寫一兩句話可以從一開始就清楚地表明程序的目的：

這個程序將會向用戶請求問候。如果問候匹配特定響應，則回覆該響應；否則就會被拒絕。

3、寫下開頭語句。第一條命令——也就是程序執行時應當做的第一件事——同時也是第一行：

print greeting"你好，陌生人！"

4、添加下一行。上下行之間透過按? Enter留出空間，然後創建下一行代碼。在本例中，應當由用戶發起下一行對話：

print prompt按“回車鍵”繼續<user presses "Enter">

5、添加操作調用。本例中，用戶將會被提示輸入問候。

print call-to-action“你好嗎？”

6、給用戶顯示響應列表。同樣，在本例中，按? Enter後，用戶將會看到可選擇的響應列表。

display possible responses "1.不錯。""2.很好！""3.不太好。"

7、請求用戶輸入。在這裏程序會要求用戶輸入一個響應：

print request for input "輸入最適合你的選項數字："

8、爲用戶的輸入創建“if”指令。由於用戶有多種響應方式可選擇，所以還要根據用戶選擇的響應來添加多種結果：

if "1"print response"挺好的！"if "2"print response"太棒了！"if "3"print response"放鬆點，弱雞！"

9、添加錯誤消息。如果用戶選擇了錯誤的響應，可以準備一條錯誤消息：

if input isn't recognizedprint response"你不太聽話啊，難道不是嗎？"

10、添加程序的其他組件。仔細檢查文檔，添加或充實任何細節，確保你自己和任何閱讀文檔的人都能理解它的含義。根據這個方法的例子，最終的僞代碼文檔應該是這樣的：

這個程序將會向用戶請求問候。如果問候匹配特定響應，則回覆該響應；否則就會被拒絕。print greeting"你好，陌生人！"print prompt按“回車鍵”繼續<user presses "Enter">print call-to-action"你好嗎？"display possible responses "1.不錯。""2.很好！""3.不太好。"print request for input "輸入最適合你的選項數字："if "1"print response"挺好的！"if "2"print response"太棒了！"if "3"print response"放鬆點，弱雞！"if input isn't recognizedprint response"你不太聽話啊，難道不是嗎？"

11、儲存文檔。按Ctrl+S（Windows）或? Command+S（Mac），輸入名稱，並點擊“儲存”。

小提示

警告