スクラッチコーチのコーディング規約

スクラッチプログラミングに挑戦している皆さん、どうも！スクラッチコーチです。

スクラッチのチュートリアルで使(つか)われているスクラッチコーチのコーディング規約(きやく)をまとめておきます！

コーディング規約(きやく)とは？

コーディング規約(きやく)というのはシステム開発(かいはつ)やゲーム制作(せいさく)の現場(げんば)ごとに定義(ていぎ)されている「どうやってコーディングするか」というルールのことです。

例(たと)えば変数(へんすう)名(めい)の付(つ)け方(かた)

たとえば最近(さいきん)のIT現場(げんば)における変数(へんすう)の名前(なまえ)に関(かん)するコーディング規約(きやく)だと、キャメルケースとスネークケースのどちらかが多(おお)い印象(いんしょう)です。

• キャメルケースとは……「scratchGameDevelopment」のように、「scratch」「game」「development」という文字(もじ)のつなぎ部分(ぶぶん)を大文字(おおもじ)にする書(か)き方(かた)。ただし最初(さいしょ)の文字(もじ)は小文字(こもじ)。キャメルというのはラクダのことで、文字(もじ)の感(かん)じがラクダのコブっぽいという由来(ゆらい)。かわいい。
• スネークケースとは……「scratch_game_development」のように文字(もじ)のつなぎにアンダーバーを使(つか)う書(か)き方(かた)。なんとなくヘビっぽいからという由来(ゆらい)。

個人的(こじんてき)な感覚(かんかく)だとJava、Javascript、Python、Rubyなどの最近(さいきん)メジャーな言語(げんご)ではキャメルケースのほうが多(おお)いかな。スネークケースはPHP（とくにWordPress）でよく使(つか)われている印象(いんしょう)。スクラッチだと日本人(にほんじん)は変数(へんすう)名(めい)は日本語(にほんご)で付(つ)けたほうが分(わ)かりやすいと思(おも)うから、キャメルケースは使(つか)えないし、スネークケースもそこまで使(つか)われてないかな。

スクラッチのコーディング規約(きやく)

ココからは実際(じっさい)にスクラッチコーチで使(つか)っているコーディング規約(きやく)をまとめておきます！

変数(へんすう)名(めい)

基本的(きほんてき)に変数(へんすう)名(めい)は日本語(にほんご)で書(か)きます。ただしXやYなど、英語(えいご)のほうが分(わ)かりやすい部分(ぶぶん)は英語(えいご)を使(つか)います。

変数(へんすう)の種類(しゅるい)を見分(みわ)ける書(か)き方(かた)

スクラッチには大(おお)きく２通(とお)りの変数(へんすう)があります。

• すべてのスプライトに共通(きょうつう)の変数(へんすう)（グローバル変数(へんすう)）
• このスプライトでのみ使(つか)う変数(へんすう)（ローカル変数(へんすう)）

公式(こうしき)のこの２つに加(くわ)えて、さらにもう２つスクラッチコーチでは独自(どくじ)に定義(ていぎ)しています。

• １度(ど)だけ値(ね)をセットしたら２度(ど)と変更(へんこう)しないグローバル変数(へんすう)（定数(ていすう)）
• このスプライトのみで使(つか)う上(うえ)に、あるブロック定義(ていぎ)内(ない)でのみ使(つか)われる一時的(いちじてき)な変数(へんすう)（プライベート変数(へんすう)）

これらを見分(みわ)けるために以下(いか)のように接頭語(せっとうご)を使(つか)っています。

種類(しゅるい)	接頭語(せっとうご)	例(れい)
グローバル変数(へんすう) （すべてのスプライトで使(つか)う変数(へんすう)）	★	★重力(じゅうりょく) （-1など） ★難易(なんい)度(ど) ★いまのステージ
定数(ていすう) （１度(ど)定義(ていぎ)したら変更(へんこう)しないグローバル変数(へんすう)）	■	■はい　（1） ■いいえ　（2） ■あり　(1） ■なし　（2） ■30FPS　（30） ■空白(くうはく)　()
ローカル変数(へんすう) （このスプライトのみで使(つか)う変数(へんすう)）	なし	スピードY ジャンプ力(りょく)
プライベート変数(へんすう) （このスプライトのみで使(つか)う一時的(いちじてき)な変数(へんすう)）	_	_値(ね) _一時的(いちじてき)に保存(ほぞん)された速度(そくど)

真偽(しんぎ)値(ち)を格納(かくのう)する変数(へんすう)

変数(へんすう)の値(ね)が0か1（falseかtrue）になる変数(へんすう)は接尾語(せつびご)を「～かどうか」にします。長(なが)過(す)ぎたら「～か」でもOK。例(れい)）ジャンプ中(ちゅう)かどうか例(れい)）空中(くうちゅう)にいるか

ブロック定義(ていぎ)名(めい)

基本的(きほんてき)にブロック定義(ていぎ)名(めい)は日本語(にほんご)で書(か)きます。ブロック定義(ていぎ)名(めい)は動詞(どうし)で書(か)きます。例(れい)）ジャンプを行(おこな)うブロック定義(ていぎ)であれば、「ジャンプ」ではなく「ジャンプする」「飛(と)ぶ」「跳(は)ねる」など

再(さい)描画(びょうが)するブロック定義(ていぎ)かどうかを見分(みわ)ける書(か)き方(かた)

ブロック定義(ていぎ)には再(さい)描画(びょうが)するものとしないものがあります。パッと見(み)ただけで分(わ)かるように接頭語(せっとうご)を付(つ)けて判断(はんだん)します（最近(さいきん)そうし始(はじ)めました）

種類(しゅるい)	接頭語(せっとうご)	例(れい)
再(さい)描画(びょうが)が必要(ひつよう)である	なし	ジャンプする アニメーションする
再(さい)描画(びょうが)が不要(ふよう)である	_ （アンダーバー）	_空中(くうちゅう)にいるか調(しら)べる _スピンできるか調(しら)べる _埋(うず)もれを修正(しゅうせい)する

引数(ひきすう)は引数(ひきすう)名(めい)をラベルでも書(か)く

ブロック定義(ていぎ)には引数(ひきすう)を渡(わた)せますが、この引数(ひきすう)名(めい)を敢(あ)えてラベルでも書(か)き残(のこ)しておきます。たとえばコレ↓

「値(ね)」という引数(ひきすう)が定義(ていぎ)されています。そして「エンコードする）値(ね)：」というように「値(ね)：」という引数(ひきすう)名(めい)を敢(あ)えてラベルにも書(か)いてあります。この状態(じょうたい)だと冗長(じょうちょう)に思(おも)えますが、実際(じっさい)にブロック定義(ていぎ)を使(つか)う時(とき)に便利(べんり)です。見(み)てみましょう↓

↑このように引数(ひきすう)は空白(くうはく)になってしまいます。そうすると「あれ、ここって何(なに)いれるんだっけ？」といちいちブロック定義(ていぎ)の引数(ひきすう)名(めい)を調(しら)べる必要(ひつよう)があります。そのひと手間(てま)が面倒(めんどう)なので、最初(さいしょ)からラベルに引数(ひきすう)名(めい)を書(か)き残(のこ)しておきます。

メッセージの書(か)き方(かた)

基本的(きほんてき)に日本語(にほんご)で書(か)く。最近(さいきん)は不自然(ふしぜん)でなければ語尾(ごび)は「～します」「～しました」で整(ととの)えています。例(れい)）ゲームを開始(かいし)します例(れい)）被弾(ひだん)しました例(れい)）停止(ていし)ボタンが押(お)されました例(れい)）ステージをクリアしました

条件(じょうけん)分岐(ぶんき)やループなどの囲(かこ)みは極力(きょくりょく)ネストさせない

ネストというのは「もし～なら」の中(なか)でさらに「もし～なら」を使(つか)うこととか、「ずっと」ループの中(なか)で「もし～なら」を使(つか)うことです。ネスト自体(じたい)は悪(わる)いことじゃないし、むしろ絶対(ぜったい)ネストしないと無理(むり)な場面(ばめん)って多(おお)い。だけど「もし」の中(なか)で５回(かい)も６回(かい)も「もし」が使(つか)われてたりすると、すごく見(み)づらくなります。こんな↓

こういうのを「ネストの階層(かいそう)が深(ふか)い」と表現(ひょうげん)するのですが、階層(かいそう)が深(ふか)すぎるとデバッグが大変(たいへん)になりがちです。

• なんで「もし」の色(いろ)が違(ちが)うの？

  ＼u003cp＼u003e上(うえ)の画像(がぞう)は「もし」の色(いろ)がオレンジと黄色(きいろ)になってて、ネストしても少(すこ)し見(み)やすくなってます。これは＼u003ca href=＼u0022https://scratchaddons.com/ja/addons/＼u0022 target=＼u0022_blank＼u0022 rel=＼u0022noreferrer noopener nofollow＼u0022＼u003eグリフパッチさん達(たち)が開発(かいはつ)してくれているスクラッチアドオン＼u003c/a＼u003eというChromeアドオンのおかげです。気(き)になる方(ほう)はチェックしてみてください。＼u003c/p＼u003e

そこで、可能(かのう)ならネストは極力(きょくりょく)しないように作(つく)れるように心(こころ)がけてます。可能(かのう)なら！

↑左(ひだり)と右(みぎ)のブロック群(ぐん)はまったく同(おな)じ処理(しょり)なんですが、どっちが好(この)みですか？好(この)みにもよるのですが、左(ひだり)はネストをさせないようにしたバージョン。右(みぎ)はネストしまくってるバージョンです。処理(しょり)の内容(ないよう)自体(じたい)は全(まった)く同(おな)じですが、左(ひだり)のほうが個人的(こじんてき)には好(この)みです。

コーディング規約(きやく)を作(つく)っちゃおう

これは僕(ぼく)なりのコーディング規約(きやく)ですが、みんな「オレオレ規約(きやく)」作(つく)ってしまってOKだと思(おも)います！別(べつ)に仕事(しごと)じゃないんだし、自分(じぶん)なりのスクラッチの作(つく)り方(かた)ベストプラクティスみたいなのを作(つく)るのも楽(たの)しみなんじゃないかなぁって思(おも)います。