開発者向けのドキュメントの整備など

[vain0x]

目標: リポジトリの内容を他の人からみても理解しやすい状態にしたい

課題 (?):

• 前提知識が多いわりに参考資料が提示されていないので、とっつきづらいと思われる
• 内部設計が凝っているわりにドキュメントが少なく、アプリの機能がコードでどう表現されているかというのが分かりづらいと思われる

ref: #110

[vain0x]

前提知識に関して:

• (Windowsの) 標準入出力、プロセスをサーバー・クライアント間の連携に利用しているので、そこは知っている必要がある
• ビルドスクリプトのためにpwsh (PowerShell)を使っている。ビルドスクリプトは必須ではないとはいえ前提知識の1つになってしまっているかもしれない
  • pwshよりposix shell (Git Bash 上で動かす) のほうがましかもしれない
  • そもそもシェルを使わないほうが分かりやすいかもしれない
• シェル経由でのビルドのためにmsbuildを使っている
• C++ を網羅的に理解するのは大変なので、リポジトリ内で使われている範囲に絞った解説みたいなのがあったほうがとっつきやすいかもしれない

[vain0x]

内部設計に関して:

• shared_ptr とrawポインタ (T*) が混在していてややこしいかもしれない
• visitorパターンは構文的なノイズが多くて、分岐とダウンキャストのほうがよかったかもしれない

[vain0x]

proxy (kc_main_proxy.hsp) に関して:

• knowbug_clientをデバッグ実行する際に使われる。knowbug_clientをデバッグ実行して、その標準入出力を中継する
• これが間に挟まっているせいでサーバー・クライアント間の通信がややこしくなっている
• サーバー(knowbugであるhsp3debug)が直接、knowbug_clientのスクリプトをデバッグ実行すれば、proxyを挟まなくてもいい気がする
  • つまり、knowbugが置かれているのとは別のhsp3のインストールディレクトリを使って、hsp3.exeにknowbug_client.axを載せて起動する。そこには標準のデバッガが置いたままなので、knowbugは起動されない