擬似コードの書き方

このwikiHowでは、コンピュータプログラムの疑似コードドキュメントを作成する方法を説明します。疑似コードとは、本質的には、コードの目的を概説する非プログラミング言語を作成することです。 ^{[1] X研究ソース}

パート1 パート1/3:

疑似コードの基本概念を理解する

1疑似コードとは何かを理解します。疑似コードはコードを段階的に記述するために使用され、徐々にプログラミング言語に変換できます。多くのプログラマーは、技術的に要求の厳しいコードを書く前に、疑似コードを使用してアルゴリズムの機能を計画します。
疑似コードは非公式のガイドであり、プログラミングの問題を考えるためのツールであり、自分のアイデアを他の人に伝えるのに役立つ方法です。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/a\/a8\/1494423-2.jpg\/v4-460px-1494423-2.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/a\/a8\/1494423-2.jpg\/v4-728px-1494423-2.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 2疑似コードが役立つ理由を理解します。疑似コードは、アルゴリズムがどのように動作するかを示すために使用されます。プログラマーは、初期の計画段階と実際の実行可能コードの記述の間のプログラミングの中間ステップとして、疑似コードを使用することが多いです。疑似コードのその他の用途としては、次のものがあります。
- アルゴリズムがどのように動作するかを説明します。疑似コードは、プログラム内のどこで特定のアーキテクチャ、メカニズム、またはテクニックを使用できるか、または使用する必要があるかを示すことができます。
- 技術に詳しくないユーザーにプロセスフローを説明します。コンピュータがプログラムを実行するには、非常に厳密な入力構文が必要ですが、一般の人々 (特にプログラマーではない人) にとっては、各コード行の目的を明確に示す、より流動的で主観性の少ない言語の方が理解しやすい場合があります。
- チーム環境でコードを設計します。上級ソフトウェアアーキテクトは、プログラマーが遭遇する複雑な問題を解決できるように、設計に疑似コードを組み込むことがよくあります。他のプログラマーと一緒にプログラムを開発している場合、意図を明確にするために疑似コードが役立つことがあります。
{"smallUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/6c\/Write-Pseudocode-Step-3-Version-4.jpg\/v4-460px-Write-Pseudocode-Step-3-Version-4.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/6c\/Write-Pseudocode-Step-3-Version-4.jpg\/v4-828px-Write-Pseudocode-Step-3-Version-4.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 3疑似コードは主観的かつ非標準的であることに留意してください。疑似コードでは必ずしも決まった構文を使用する必要はありませんが、標準的な疑似コード構造を使用すると他のプログラマーが理解しやすくなるため、業界では一般的な慣行となっています。 ^{[2] X研究ソース}自分でプロジェクトを作成する場合、最も重要なことは、疑似コードが考えを整理し、計画を立てるのに役立つことです。
- 同僚、ジュニアプログラマー、非技術系のパートナーなど、他の人と一緒にプロジェクトを開発する場合は、他の人があなたの意図を簡単に理解できるように、少なくとも何らかの標準構造を使用することが重要です。
- 大学、コーディングブートキャンプ、または企業でプログラミングコースを受講した場合、疑似コードの「標準」に基づいてテストされる可能性があります。このような基準は、教育機関や教師によって異なることがよくあります。
疑似コードの主な目的は明確さであり、確立されたプログラミング規則に従う場合、疑似コードが役立つ場合があります。疑似コードを実際のコードに変換する際には、それをプログラミング言語に変換する必要があります。そのため、疑似コードはコードのアウトラインを構造化するのに役立ちます。
4疑似コードの主な目的に焦点を当てます。疑似コードを書くと、結局コードを書くことになりがちです。疑似コードの目的、つまりプログラムの各行が何を行うのかを説明することを念頭に置いておくと、疑似コードドキュメントを作成するときに混乱を招かなくなります。広告する

パート2 パート2/3:

良い疑似コードを書く

1プレーンテキストエディタを使用します。 Microsoft Word などのワードプロセッサや類似のプログラムを使用してリッチテキストドキュメントを作成したいと思うかもしれませんが、擬似コードでは簡潔さを保つために書式設定を最小限に抑える必要があります。
プレーンテキストエディターには、メモ帳 (Windows) や TextEdit (Mac) などがあります。
2まず、このプロセスの目的を書き留めます。コードの動作を 1 行か 2 行説明しておくと、疑似コードを読むすべての人にプログラムの動作を説明する必要がなくなり、ドキュメントの残りの部分の準備に役立ちます。
3 1 行に 1 つのステートメントのみを記述します。疑似コード内の各ステートメントは、コンピューターの 1 つの操作のみを表す必要があります。ほとんどの場合、タスクリストが適切に記述されていれば、各タスクは 1 行の疑似コードに対応します。タスクのリストを書き出し、そのリストを疑似コードに変換し、その疑似コードを徐々に実際のコンピューターで読み取り可能なコードに変換することを検討してください。 ^{[3] X研究ソース}
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/6\/6b\/1494423-8.jpg\/v4-460px-1494423-8.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/6b\/1494423-8.jpg\/v4-728px-1494423-8.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 4空白とインデントを効果的に使用します。テキストの「ブロック」間にスペースを使用すると、疑似コードのさまざまな部分を分離するのに役立ちます。また、各ブロックのさまざまな部分をインデントすると、これらの疑似コードがインデントが少ないコードセクションに属していることが示されます。
- たとえば、数値の入力に関する疑似コードの部分はすべて同じ「ブロック」内にある必要がありますが、次の部分 (たとえば、出力に関する部分) は別のブロック内にある必要があります。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/5\/59\/1494423-9.jpg\/v4-460px-1494423-9.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/5\/59\/1494423-9.jpg\/v4-728px-1494423-9.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 5必要に応じて、重要な指示を大文字にします。擬似コードの要件や擬似コードを公開する環境によっては、実際のコードに保持されている命令を大文字にする必要がある場合があります。
- たとえば、疑似コードで「if」および「then」命令を使用している場合は、それらを「IF」および「THEN」に変更した方がよい場合があります (例:「IF input number THEN output result」)。
6簡単な用語を使用します。コード自体を要約するのではなく、プロジェクトが何を行うかについて書いているということを忘れないでください。これは、プログラミングを知らないクライアントへのデモンストレーションとして、または初心者向けのプロジェクトとして疑似コードを作成する場合に特に重要です。 ^{[4] X研究ソース}
プログラミングの指示を一切省略し、代わりに各行のフローをわかりやすい言葉で定義することもできます。たとえば、「入力が奇数の場合、出力 'Y'」は、「ユーザーが奇数を入力した場合、表示 'Y'」と記述できます。
7擬似コードを適切な順序に保ちます。疑似コードを装飾するために使用される言語は簡潔に保つ必要がありますが、コードが実行される順序に従って疑似コードの各部分の順序を維持する必要があります。
8すべてを明確に記述する必要があります。プロセスで発生するすべてのことを完全に説明することが不可欠です。疑似コードステートメントは、単純な英語のステートメントに似ています。疑似コードでは通常、変数は使用されませんが、代わりに口座番号、名前、取引金額など、現実世界に近いオブジェクトをプログラムがどのように処理するかを記述します。 ^{[5] X研究ソース}
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/d\/db\/1494423-13.jpg\/v4-460px-1494423-13.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/d\/db\/1494423-13.jpg\/v4-728px-1494423-13.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 9標準的なプログラミング構造を使用します。疑似コードには標準がありませんが、既存のプログラミング言語 (シーケンシャルプログラミング言語) の構造を使用すると、他のプログラマーが手順を理解しやすくなります。 ^{[6] X研究ソース}「if」、「then」、「while」、「else」、「loop」という用語を、自分のプログラミング言語と同じように使用します。次の構造を考えてみましょう。
- 「条件」が満たされれば「命令」が実行される」は、指定された条件が満たされる場合にのみ、指定された命令が実行されることを意味します。この場合、「命令」はプログラムが実行する手順を指し、「条件」はプログラムを実行する前にデータが満たす必要のある特定の基準のセットを指します。 ^{[7] XResearchソース}
- while "条件" do "命令" -- は、条件が真でなくなるまで命令を何度も繰り返す必要があることを意味します。 ^{[8] XResearchソース}
- do "条件" while 条件- この構造は、「while "条件" do "命令"」構造と非常によく似ています。最初のケースでは、命令が実行される前に条件がチェックされますが、2 番目のケースでは、命令が最初に実行されます。したがって、2 番目のケースでは、命令は少なくとも 1 回実行されます。
- 関数名 (パラメーター): 命令- コード内で特定の名前が使用されるたびに、それが特定の命令の略語であることを意味します。「パラメータ」は、命令を解釈するために使用できる変数のリストです。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/6\/6e\/1494423-14.jpg\/v4-460px-1494423-14.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/6\/6e\/1494423-14.jpg\/v4-728px-1494423-14.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 10.疑似コード部分を整理します。同じブロック内で他の疑似コードスニペットを定義する大きな疑似コードブロックがある場合は、すべてを囲むために角括弧またはその他の識別子を使用する方がよいでしょう。
- 中括弧 - 標準の角括弧 (例: [code]) と中括弧 (例: {code}) の両方を使用して、疑似コードの大きなセクションを囲むことができます。
- プログラミング時に、コメントの左側に「//」と入力してコメントを追加できます (例: //这是一个临时步骤)。疑似コードを書くときにも同じテクニックを使って、コード化されたテキストに収まらないものをコメントとして書き留めることができます。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/2\/2c\/Write-Pseudocode-Step-15.jpg\/v4-460px-Write-Pseudocode-Step-15.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/2\/2c\/Write-Pseudocode-Step-15.jpg\/v4-728px-Write-Pseudocode-Step-15.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 11擬似コードの読みやすさと明確さを慎重に確認します。全文を読んだ後、次の質問に答えられるようになるはずです。
- この疑似コードは、プロセスに詳しくない人でも理解できるでしょうか?
- 疑似コードは、コンピューティング言語に簡単に変換できるような方法で記述されていますか?
- 疑似コードは、何も省略せずにプロセス全体を記述していますか?
- 疑似コードで使用されている各オブジェクト名は、対象読者にとって明確に理解できるものですか?
- 疑似コードの一部に詳細化が必要だったり、他の人が忘れてしまうような手順が明確に示されていないことがわかった場合は、その部分に戻って必要な情報を追加する必要があります。
広告する

パート 3パート3/3:

擬似コードドキュメントの例を作成する

1プレーンテキストエディターを開きます。新しいプログラムをインストールしたくない場合は、デフォルトのプログラムであるメモ帳 (Windows) または TextEdit (Mac) を使用できます。
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/b\/bf\/1494423-17.jpg\/v4-460px-1494423-17.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/b\/bf\/1494423-17.jpg\/v4-728px-1494423-17.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 2プログラムを定義します。必須ではありませんが、ドキュメントの先頭に 1 つか 2 つの文を書くと、プログラムの目的が最初から明確になります。
```
このプログラムはユーザーに挨拶を要求します。挨拶が特定の応答と一致する場合は、その応答が返されます。一致しない場合は拒否されます。
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/c\/cc\/1494423-18.jpg\/v4-460px-1494423-18.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/c\/cc\/1494423-18.jpg\/v4-728px-1494423-18.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 3冒頭の文を書きます。最初のコマンド (プログラムの実行時に最初に行うべきこと) は、最初の行でもあります。
```
挨拶文を印刷する
	「こんにちは、見知らぬ人！」
```
4 次の行を追加します。 ↵ Enterを押して前の行と次の行の間にスペースを空けてから、次のコード行を作成します。この場合、ユーザーは次のダイアログ行を開始する必要があります。
```
印刷プロンプト
	続行するには「Enter」を押してください <ユーザーが「Enter」を押します>
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/0\/08\/1494423-20.jpg\/v4-460px-1494423-20.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/0\/08\/1494423-20.jpg\/v4-728px-1494423-20.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 5アクション呼び出しを追加します。この例では、ユーザーに挨拶を入力するよう求められます。
```
行動喚起を印刷する
	"大丈夫ですか？"
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/a\/a7\/1494423-21.jpg\/v4-460px-1494423-21.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/a\/a7\/1494423-21.jpg\/v4-728px-1494423-21.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 6ユーザーへの応答のリストを表示します。この例では、 ↵ Enter を押すと、ユーザーに選択できる応答のリストが表示されます。
```
可能な応答を表示する 
	「1. 悪くない。」
	「2. とても良い！」
	「3. あまり良くない。」
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/4\/4e\/1494423-22.jpg\/v4-460px-1494423-22.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/4\/4e\/1494423-22.jpg\/v4-728px-1494423-22.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 7ユーザー入力を要求します。ここでプログラムはユーザーに応答を入力するように求めます。
```
入力要求を印刷する 
	「あなたの選択に最も適した番号を入力してください:」
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/a\/a7\/1494423-23.jpg\/v4-460px-1494423-23.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/a\/a7\/1494423-23.jpg\/v4-728px-1494423-23.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 8ユーザーの入力に対する「if」命令を作成します。ユーザーは複数の応答から選択できるため、ユーザーが選択した応答に基づいて複数の結果を追加する必要もあります。
```
 「1」の場合
	応答を印刷する
		"大丈夫！"

「2」の場合
	応答を印刷する
		"素晴らしい！"

「3」の場合
	応答を印刷する
		「落ち着け、弱虫！」
```
{"smallUrl":"https:\/\/www.wikihow.com\/images_en\/thumb\/f\/f5\/1494423-24.jpg\/v4-460px-1494423-24.jpg","bigUrl":"https:\/\/www.wikihow.com\/images\/thumb\/f\/f5\/1494423-24.jpg\/v4-728px-1494423-24.jpg","smallWidth":460,"smallHeight":345,"bigWidth":728,"bigHeight":546,"licensing":"<div class=\"mw-parser-output\"><\/div>"} 9エラーメッセージを追加します。ユーザーが間違った応答を選択した場合は、エラーメッセージを用意できます。
```
入力が認識されない場合
	応答を印刷する
		「君はあまり従順じゃないね。」
```

10プログラムの他のコンポーネントを追加します。ドキュメントを注意深く読み、詳細を追加または補足して、自分とドキュメントを読むすべての人がその意味を理解できるようにします。この方法の例によると、最終的な疑似コードドキュメントは次のようになります。

このプログラムはユーザーに挨拶を要求します。挨拶が特定の応答と一致する場合は、その応答が返されます。一致しない場合は拒否されます。

挨拶文を印刷する
	「こんにちは、見知らぬ人！」

印刷プロンプト
	続行するには「Enter」を押してください <ユーザーが「Enter」を押します>

行動喚起を印刷する
	"大丈夫ですか？"

可能な応答を表示する 
	「1. 悪くない。」
	「2. とても良い！」
	「3. あまり良くない。」

入力要求を印刷する 
	「あなたの選択に最も適した番号を入力してください:」

「1」の場合
	応答を印刷する
		"大丈夫！"
「2」の場合
	応答を印刷する
		"素晴らしい！"
「3」の場合
	応答を印刷する
		「落ち着け、弱虫！」

入力が認識されない場合
	応答を印刷する
		「君はあまり従順じゃないね。」