Studio Itachi コーディングポリシー ver1.00 について

こんにちは!

インディゲームを制作するディベロッパー「Studio Itachi」のZiggyです。

今回はStudio Itachiのコーディングポリシーというものについて解説していこうと思います。

内容は常に変わっていくと思うのでメインサイトのほうに載せました。

■なぜ作ったか

私はUnity+VisualStudioでC#を用いてゲームを組んでいます。
今まで作った作品の経験から、コードが滅茶苦茶すぎてどういう処理で動いているのか、どこに何が書いてるのかが分からないという問題が出ています。。

チーム開発をしたことのないド素人プログラマー(プログラマと名乗るのも恥ずかしいレベルです)なので、コードは滅茶苦茶で自分のコードを深く読まないと単純な動作がどう動いているのかわからないという状況です。

この状況を打開すべく、個人開発でありながらもコーディング規約を作ることにしました。

コーディング規約というものが何なのかから始まり、自分なりにどういう規約だとよいか、いろいろ読んだり調べたりしてみましたので参考資料や思っていることを書いていきます。

■規約とは言えないなぁ

まず、このブログのタイトルや上記リンク先は「コーディングポリシー」となっています。

なんでこんな面倒くさいことをしたかというと、コーディング規約という検索ワードで引っかかった時に、私のようにほとんど何も知らない方が混乱するのを避けたかったからです。

ポリシーという名前であれば「私はこういう感じの方針で行きますんで!」というニュアンスをこめて名付けました。

まあ、これは私だけが見るものですのでw
それなのに公開した理由は、なるべくノーガード戦法で制作することで、誰かの役になったらいいなぁと思っていたりします。

■参考資料について

コーディング規約を読むのって大変かなと思っていたのですが、全然そんなことなかったです。
読んでみるとわからないところはわからないし、わかるところはそうなんだ、というぐらいの感想でした。

そりゃそうですよね、ただの規約なので、考えさせられるようなことはないです。

参考にした資料と感想を書いておきます。

こちらがマイクロソフトの規約なのでまず読むべき内容かと思います。
通常これだけ守っとけばいいと思います。
しかし、接頭辞を付ける付けない論争であったり、コメントの書き方のルールとか、MSだから正しいよね、と言い切れないところもあるので場合によりけりかと思います。

Unityを使っているプログラミング素人はこっちを読むべきです。
MSのコーディング規約より重要です。
なぜかというと、プログラミングにおけるいろいろな原則がかかれているから。
私はGoogle翻訳をかけて読みましたが、シンプルにまとまっていて内容狩りやいしやすかったです。

Udemyの内容の書籍版とのことです。
Kindle Unlimitedでゼロ円だったので読みました。
どう書けばいいかと、なんでそうしなければいけないのかが書いてあります。
ただ、さらっと書いてあるだけなので、書籍だけだと物足りない可能性があります。
そりゃそうですよね、講座受ければもっと理解深まるよ、ということだと思うので。

これは買いました。
結構内容は難しいなぁと思いましたが、丁寧に説明が書かれていて読みやすかったこともあり二回読みました。
ただ、これだけだと原理原則が書かれていて、理解しきれない私には具体的にどうしたらいいのかわからない、、、という状態になっていました。
これを読んでから各種規約見てみるといいかもですね!

■最後に

もうすでにWebサイトのほうとこのブログの二か所にコーディングポリシーのことが書いてあり、DRYの原則に反しているような気がしますがw

いいんですいいんです。

適当に行きましょう。

これで自分のコードが読みやすくなったらいいなぁ。


もし記事が面白いなぁと思いましたら、Twitterのほうをフォローしていただけると嬉しいです!
日々のゲーム制作の進捗や、ブログの更新告知、たまにふと思ったことなんかを呟いていますのでよろしくお願いします。