ヘルプの更新、サンプルのコメント更新

Author: mj-hd

asc-simulator/Resources/help.html

@@ -1,5 +1,6 @@
-# ASC Simulatorの使い方
-
+---
+title: ASC Simulatorの使い方
+lang: ja
 ---
 
 # 目次
@@ -17,84 +18,67 @@
 
 ---
 
-<span id="1-画面の説明"></span>
 # 1. 画面の説明
 ![画面](help/画面.png)
 
 [2. 機能の説明](#2-機能の説明)にて、各部の詳しい説明をします。
 
-<span id="2-機能の説明"></span>
 # 2. 機能の説明
-<span id="2-1-メニューバー"></span>
 ## 2-1. メニューバー
-<span id="ファイル"></span>
 ## ファイル
 ![ファイル](help/ファイル.png)
 
-<span id="ファイルを開く"></span>
 #### [ファイルを開く]
 asc-assembler.exeやasc-simulator.exeの出力した.ascoファイルを選択し、メモリに読み込みます。
 
 またこの時、.ascsファイルで設定したORGの値がPCに設定されます。
 
-<span id="ファイルを書き出す"></span>
 #### [ファイルへ書き出す]
 MMの内容を.ascoファイルへ書き出します。
 
 ここで書き出すファイルは、asc-assembler.exeの書き出すファイルと互換性があります。
 
-<span id="環境設定"></span>
 #### [環境設定]
 マシンビューの設定など、細かな設定をすることができます。
 
-<span id="動作"></span>
 ## 動作
 ![動作](help/動作.png)
 
-<span id="レジスタとフラグを初期化"></span>
 #### [レジスタとフラグを初期化]
 レジスタ、フラグの値を0に設定します。
 
 後述する[[初期化ボタン]![初期化](help/初期化ボタン.png)](#初期化)との違いは、命令サイクルの状態を変更しないことです。
 
-<span id="メモリを初期化"></span>
 #### [メモリを初期化]
 メモリの内容を0で初期化します。
 
-<span id="ブレークポイントを初期化"></span>
 #### [ブレークポイントを初期化]
 ブレークポイントを全て解除します。
 
-<span id="表示を更新"></span>
 #### [表示を更新]
 マシンビューの表示、MMの表示、レジスタの表示を更新します。
 表示に不具合のある場合などに使用してください。
 
-<span id="指定アドレスへ移動"></span>
 #### [指定アドレスへ移動]
 押すと、以下のようなダイアログが表示されます。
 
 ![指定アドレスへ移動](help/指定アドレスへ移動.png)
 
-表示したいアドレスを入力し、**[移動]**を押すことで、MMの表示を指定したアドレスまでスクロールすることができます。
+表示したいアドレスを入力し、[**移動**]を押すことで、MMの表示を指定したアドレスまでスクロールすることができます。
 
-<span id="ヘルプ"></span>
 ## ヘルプ
 ![ヘルプ](help/ヘルプ.png)
 ### [使い方]
 このページを表示します。
 
-<span id="このプログラムについて"></span>
 ### [このプログラムについて]
 プログラムのバージョンなどを確認することができます。
 
-<span id="2-2-マシンビュー"></span>
 ## 2-2. マシンビュー
 ASCマシンの状態を確認することができます。
 
 ![マシンビュー](help/マシンビュー.png)
 
-<span id="色について"></span>
 ### 色について
 マシンビューにおいて、値の書き換え、値の参照などが発生した場合、色が変わることがあります。
 
@@ -108,11 +92,9 @@ ASCマシンの状態を確認することができます。
 
 また、色のついた矢印は、**値が移動したこと**を表しています。
 
-<span id="2-3-メモリレジスタ"></span>
 ## 2-3. メモリ、レジスタ
-<span id="MMビューの見方"></span>
 ### MMビューの見方
-画面右の**[MM]**という表に、ASCマシンのMMの内容が表示されます。
+画面右の[**MM**]という表に、ASCマシンのMMの内容が表示されます。
 
 ![MMビュー](help/MM.png)
 
@@ -125,7 +107,6 @@ MMビューには**アドレス**、**バイナリ**、**ニーモニック**の
    .ascsファイルで定数とした値も、
    シミュレータ上では命令として解釈され表示されることに注意してください。)_
 
-<span id="MMビューの色について"></span>
 ### MMビューの色について
 MMビューの行が着色されるときがあります。
 
@@ -136,61 +117,56 @@ MMビューの行が着色されるときがあります。
 **薄い赤**は**PCの指すアドレスの命令の内容**を表しています。
 
 
-<span id="MMの内容を変更する"></span>
-### MMの内容を変更する
+### MMの内容を変更する
 **バイナリ**、**ニーモニック**の列は、クリックすることで直接書き換えることができます。
 
 値を入力した後、**Enterを押すか、他の行をクリックすること**でMMへ反映することができます。
 
-書式にエラーがあった場合は、**赤い![赤いマーク](help/赤いマーク.png)**マークが表示されます。
+書式にエラーがあった場合は、**赤い**![赤いマーク](help/赤いマーク.png)マークが表示されます。
+
+この**赤い**![赤いマーク](help/赤いマーク.png)マークにマウスオーバーすることでエラーの内容を確認することができます。
 
-この**赤い![赤いマーク](help/赤いマーク.png)**マークにマウスオーバーすることでエラーの内容を確認することができます。
 ![MMエラー](help/MMエラー.png)
 
-<span id="ブレークポイントを設定する"></span>
 ### ブレークポイントを設定する
-**[MM]**のアドレスの左にある列をクリックすることで、**ブレークポイント**を設定できます。
+[**MM**]のアドレスの左にある列をクリックすることで、**ブレークポイント**を設定できます。
 
 ![ブレークポイント](help/ブレークポイント.png)
 
 ブレークポイントとは、[デバッグ](#3-2-デバッグする)の際などに、指定したアドレスで自動的に実行を停止する機能です。
 
-ブレークポイントが設定されたアドレスは、左側に**赤い丸![赤い丸](help/赤い丸.png)**が表示されます。
+ブレークポイントが設定されたアドレスは、左側に**赤い丸**![赤い丸](help/赤い丸.png)が表示されます。
 
-この**赤い丸![赤い丸](help/赤い丸.png)**をもう一度クリックすることで、ブレークポイントを解除することができます。
+この**赤い丸**![赤い丸](help/赤い丸.png)をもう一度クリックすることで、ブレークポイントを解除することができます。
 
-また、メニューバーより**[動作]→[ブレークポイントを初期化]**機能より、全てのブレークポイントを解除することもできます。→_[ブレークポイントを初期化](#ブレークポイントを初期化)_
+また、メニューバーより[**動作**]→[**ブレークポイントを初期化**]機能より、全てのブレークポイントを解除することもできます。→_[ブレークポイントを初期化](#ブレークポイントを初期化)_
 
 ---
 
-<span id="レジスタビューの見方"></span>
 ### レジスタビューの見方
-画面右下に表示されている**[レジスタ]**という表に、レジスタとフラグの値が表示されます。
+画面右下に表示されている[**レジスタ**]という表に、レジスタとフラグの値が表示されます。
 
 ![レジスタ](help/レジスタ.png)
 
 **名前**、**値**の列にそれぞれ、**レジスタ名**と**レジスタの値**が表示されています。
 
-<span id="レジスタの内容を変更する"></span>
 ### レジスタの内容を変更する
 **値**列はクリックすることで編集することができます。
 
 **Enterを押すことや、他の行をクリックすること**で編集内容をレジスタに反映することができます。
 
-入力にエラーがあった場合は、**赤い![赤いマーク](help/赤いマーク.png)**マークが表示されます。
+入力にエラーがあった場合は、**赤い**![赤いマーク](help/赤いマーク.png)マークが表示されます。
 
-この**赤い![赤いマーク](help/赤いマーク.png)**マークにマウスオーバーすることでエラーの内容を確認することができます。
+この**赤い**![赤いマーク](help/赤いマーク.png)マークにマウスオーバーすることでエラーの内容を確認することができます。
 
 ![レジスタエラー](help/レジスタエラー.png)
 
 
-<span id="2-4-ツールバー"></span>
 ## 2-4. ツールバー
 画面下部のツールバーには、ASCマシンの動作を操作するボタンなどが配置されています。
 
 ![ツールバー](help/ツールバー.png)
 
-<span id="初期化"></span>
 ### 初期化
 ![初期化](help/初期化ボタン.png)
 
@@ -201,38 +177,31 @@ ASCマシンの**レジスタとフラグの値を0に設定**し、**命令サ
 
 プログラムを実行しなおす際などには、基本的にはこちらを使用してください。
 
-<span id="通常実行"></span>
 ### 通常実行
 ![通常実行](help/通常実行ボタン.png)
 
 ASCマシンを、**HLT命令**か**ブレークポイント**があわられるまで実行します。
 
-手動で停止する際は、後述する**[[ブレーク]](#ブレーク)ボタン![](help/ブレークボタン.png)**を使用してください。
+手動で停止する際は、後述する[[**ブレーク**]](#ブレーク)ボタン![](help/ブレークボタン.png)を使用してください。
 
-<span id="命令単位ステップラン"></span>
 ### 命令単位ステップラン
 ![命令単位ステップラン](help/命令単位ステップランボタン.png)
 
 ASCマシンを、**次の命令まで実行して停止します。**
 
 
-<span id="状態単位ステップラン"></span>
 ### 状態単位ステップラン
 ![状態単位ステップラン](help/状態単位ステップランボタン.png)
 
 ASCマシンを、**次の状態まで実行して停止します。**
 
-<span id="ブレーク"></span>
 ### ブレーク
 ![ブレーク](help/ブレークボタン.png)
 
-ASCマシンを、**現在の状態で停止します。**
-
-HLT命令で停止している際も、一度このボタンを押してから各種操作をするようにしてください。
+通常実行時に**実行を（強制的に）中断し停止します。**
 
 ---
 
-<span id="実行速度コントローラ"></span>
 ### 実行速度コントローラ
 ![実行速度コントローラ](help/実行速度コントローラ.png)
 
@@ -242,63 +211,58 @@ HLT命令で停止している際も、一度このボタンを押してから
 
 また、処理に時間のかかるプログラムなどは、実行速度を速めることで高速に実行することができます。
 
-<span id="3-基本的な使い方"></span>
 # 3. 基本的な使い方
-<span id="3-1-自分で作ったプログラムを実行する"></span>
 ## 3-1. 自分で作ったプログラムを実行する
 このシミュレータは、同封のasc-assembler.exeの出力する、.ascoファイルを読み込むことができます。
 
 以下に、このシミュレータを使ってプログラムを実行する手順を示します。
 
-1. **[初期化]ボタン**![初期化](help/初期化ボタン.png)を押す。
-2. メニューバーより、**[ファイル]**→**[ファイルを開く]**を押す。
-3. 読み込みたいファイルを選択し、**[開く]**を押す。
+1. [**初期化**]**ボタン**![初期化](help/初期化ボタン.png)を押す。
+2. メニューバーより、[**ファイル**]→[**ファイルを開く**]を押す。
+3. 読み込みたいファイルを選択し、[**開く**]を押す。
 4. 画面下部のステータスバーで、読み込みの成功を確認する。
-5. **[通常実行]**ボタン![通常実行](help/通常実行ボタン.png)を押す。
+5. [**通常実行**]ボタン![通常実行](help/通常実行ボタン.png)を押す。
 
 以上の手順で、プログラムを実行することができます。
 
 **(2, 3の手順を、ファイルをドラッグ&ドロップすることによって代用することもできます。)**
 
-<span id="3-2-デバッグする"></span>
 ## 3-2. デバッグする
 
 読み込んだプログラムをデバッグするための手順を、以下に示します。
 
 1. 動作を確認したいアドレスに、ブレークポイントを設定する。→
 _[ブレークポイントを設定する](#ブレークポイントを設定する)_
-2. **[通常実行]ボタン![通常実行](help/通常実行ボタン.png)**を押す。
-3. ブレークポイントで停止するので、**[命令単位ステップラン]ボタン![命令単位](help/命令単位ステップランボタン.png)**や
-**[状態単位ステップラン]ボタン![状態単位](help/状態単位ステップランボタン.png)**を使い、動作を確認する。
-4. バグを確認したら、MMの該当のアドレスを書き換える。→ _[MMの内容を変更する](#MMの内容を変更する)_
-5. **[初期化]ボタン![初期化](help/初期化ボタン.png)**を押して、レジスタとフラグを初期化する。
+2. [**通常実行**]**ボタン**![通常実行](help/通常実行ボタン.png)を押す。
+3. ブレークポイントで停止するので、[**命令単位ステップラン**]**ボタン**![命令単位](help/命令単位ステップランボタン.png)や
+[**状態単位ステップラン**]**ボタン**![状態単位](help/状態単位ステップランボタン.png)を使い、動作を確認する。
+4. バグを確認したら、MMの該当のアドレスを書き換える。→ _[MMの内容を変更する](#mmの内容を変更する)_
+5. [**初期化**]**ボタン**![初期化](help/初期化ボタン.png)を押して、レジスタとフラグを初期化する。
 6. PCの値をプログラムの初期位置に変更し、手順2へ戻る。→ _[レジスタの内容を変更する](#レジスタの内容を変更する)_
 
 バグの改善が確認できるまで、この操作を繰り返してください。
 
 ブレークポイントで停止している間に、RやZ, Nなどの値を変更することも、バグの特定につながります。
 
-<span id="3-3-シミュレータ上でプログラムを作成する"></span>
 ## 3-3. シミュレータ上でプログラムを作成する
 
-[MMの変更機能](#MMの内容を変更する)により、シミュレータ上でプログラムを作成することも可能です。
+[MMの変更機能](#mmの内容を変更する)により、シミュレータ上でプログラムを作成することも可能です。
 
 以下に、その手順を示します。
 
 1. MMが初期化されていることを確認する。→ _[メモリを初期化](#メモリを初期化)_
-2. MMの内容を書き換え、プログラムを作成する。→ _[MMの内容を変更する](#MMの内容を変更する)_
+2. MMの内容を書き換え、プログラムを作成する。→ _[MMの内容を変更する](#mmの内容を変更する)_
 3. PCの値をプログラムの開始位置に設定する。→ _[レジスタの内容を変更する](#レジスタの内容を変更する)_
-4. **[通常実行]ボタン![通常実行](help/通常実行ボタン.png)**を押し、動作を確認する。
+4. [**通常実行**]**ボタン**![通常実行](help/通常実行ボタン.png)を押し、動作を確認する。
 5. デバッグをする。→ _[3-2. デバッグする](#3-2-デバッグする)_
-6. メニューバーより、**[ファイル]**→**[ファイルへ書き出す]**を押し、プログラムを保存する。
+6. メニューバーより、[**ファイル**]→[**ファイルへ書き出す**]を押し、プログラムを保存する。
 
 ここで書き出した.ascoファイルは、asc-assembler.exeの出力するファイルと互換性があるため、再びシミューレータで読み込むことができます。
 
 
-<span id="4-注意点"></span>
 # 4. 注意点
 * メモリの内容を書き出す際、0番地から書き出されます。
 * メモリの内容を書き出したファイルのサイズは、変更されているメモリの最後の番地の、
 次の2の倍数byteになります。(例えば、メモリの使用が0xF0〜0xFF番地までの場合、128byteになります)
 * 実行中は、メモリ、レジスタの値は変更することができません。
-* HLT命令でASCマシンが停止した場合も、ブレークボタンを押すまで操作はできません。
+* ADD、SUB命令によりオーバフローが発生した場合、マシンはブレークし、「オーバフローが発生しています」と表示します。

asc-simulator/Resources/help.md

@@ -0,0 +1,8 @@
+input-file: help.md
+output-file: help.html
+from: commonmark_x
+to: html
+css:
+  - github.css
+standalone: true
+wrap: preserve

asc-simulator/Resources/pandoc.yaml

@@ -187,6 +187,8 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
+    <None Include="resources\help.md" />
+    <None Include="resources\pandoc.yaml" />
     <None Include="resources\Run.png" />
   </ItemGroup>
   <ItemGroup>

asc-simulator/asc-simulator.csproj

@@ -1,11 +1,12 @@
 ; ビットカウント
 ; Data中の1を数え、結果をCountに格納する
 ;
-; 1を数えるために1ビットだけ1が立ったマスクを使用するが、
-; シフト命令がないため、マスクの作成は000...001から出発して
-; 同じデータを加算することにより行っている。
-; このマスクとの論理積が1となるか、0となるかのテストによって
-; 1が立っているかどうかを判定し、計数する。
+; 1を数えるために1ビットだけ1が立ったマスクを使用する。
+; シフト命令がないため、マスクの作成は、000...001から出発して、
+; 同じデータを加算して2倍することにより1ビット左シフトする
+; ことを繰り返して行っている。
+; このマスクとDataとの論理積が0となるかどうかをテストして
+; 該当するビット位置に1が立っているかどうかを判定し、計数する。
 ; なお、MSBのテストのために、010...000+010...000→100...000を
 ; 行うとオーバフロー割り込みを起こすため、MSBだけは、
 ; あらかじめ100...000をマスクとして用意してテストに用いている。

resources/sample/BITCOUNT.ascs

@@ -23,7 +23,7 @@ Next	LD	C	; C←A*B
 	B	FLoop	;ループの先頭へ戻る
 EndFact	HLT		;正常終了
 
-; かけ算サブルーチン-A×Bを計算してCに置く
+; かけ算サブルーチン[A×Bを計算してCに置く]
 MULT	LD	Zero
 MLoop	ADD	A
 	ST	C