現在コード内で main
と呼ばれているものに適切な命名をする
#167
Labels
dev-enhancement
documentation
Improvements or additions to documentation
help wanted
Extra attention is needed
問題意識
現在、コード内に main という名前の物体がいくつかある。その中の一つに、以下に説明する名前なき概念を表すために便宜上用いられている main がある。
文脈解説
cerke_online のフロントエンドがやることというのは、以下の二種類しかない。
(実は、バックエンドの POST 先 URL はこの「決断か?それとも poll か?」を元に再編成すれば明らかにきれいになる。したがって、この issue 解決前に勝手に解決しておくこととする。)
さて、机戦において、ユーザーが成す決断には何種類かある。それは以下の通りである。
② には AfterHalfAcceptance という名前があり、③ の「皇を動かす」「持ち駒から駒を打つ」「踏越えしないように駒を動かす」「踏越え後に有限移動しかしないように駒を動かす」には NormalMove という名前があり、③ の 「駒を踏んでそこから無限移動をしてやるぞという決断をする」には InfAfterStep という名前がある。これらの名前を私はどれも気に入っていないが、それはそれとしてこれらの名前は一貫して用いられている(ただし、関数名に NormalMove の意味で normalMessage となっているやつがあった。是正する)。
一方で、一貫していないのが
main
だったり空文字列だったりで命名されているやつである。こいつらはヤバいし非常にマズい(語彙力)。具体例
「②または③」が
main
だったり空文字列だったりで命名されている例/slow
: ② または ③ が送りつけられる POST 先 URL 。/slow
という名前が付いている経緯は、 ephemera/2021-11-06-current-situation.md を引用すると、以下の通りである。slow
な空文字列だから URL は/slow
」となったのである。sendStuff()
: ② または ③ を/slow
に送る関数。ちなみに、これ以外のやつはawait sendStuffTo<{}, RetTaXot>("whethertymok/taxot", ...
みたいに URL を指定して送る。こいつも要はsend{ここに名前を入れたいが、いい名前が思いつかなかったので空文字列}Stuff
ということ。main()
:/slow
に送られてきた ② または ③ の JSON 構造を検査し、処理する関数。analyzeValidMessageAndUpdate()
:/slow
に送られてきた ② または ③ を処理する関数。この ValidMessage といいうのは、これまたValid{ここに名前を入れたいが、いい名前が思いつかなかったので空文字列}Message
という意味である。「③」が
main
だったり空文字列だったりで命名されている例/mainpoll
: 相手が ③ の決断をしたかどうかを問うための POST 先 URL 。MAIN_POLLING_ALLOWED
,forbidMainPolling(), isMainPollingAllowed(), allowMainPolling()
: 上記問いかけをしてよいかを判断・制御するやつ。replyToMainPoll
:/mainpoll
に来たやつに返事をする今後の展望
/slow
の責務から ② の処理を引き剥がし、命名せねばならない対象を ③ のみとするmain
とかいう一般的すぎる単語が用いられていることが問題なので、パイグ語・リパライン語で命名するのも可とする。それはそれとして用語集は整備が要るんだよな)、それで全てを統一するThe text was updated successfully, but these errors were encountered: