メンテしやすいコードを書くために４つの習慣を始めてみた。

どうしてもコードは独りよがりの書き方になってしまいがちです。

それらを強制し、チームで共有し易く、そしてメンテナンスし易くするための気をつけたい習慣を記してみます。

気をつけるべき習慣を４つ紹介します。

・コーディング規約を知る。

・他人のコードを読む。

・書く。

・公開する。

１、コーディング規約を知る。

コーディング規約をしりましょう。話はそれからです。

・インデントの幅

・function(){}の{}は改行するのか？

・/**　←上のアスタリスクは2個

*

*

*/ ←下のアスタリスクは1個

この様に枠を知る事が重要です。

メリット：

・この書き方に規約に準拠したコードが読み易くなる。

→例えば仲間にこれを求める事で、仲間のコードが読み易くなりますよね。また、仲間もあなたのコードを読み易いと思ってくれるでしょう。

・保全性の向上。

→コメントを書く事で、仕様変更の時に保全性を発揮します。また、書いた人以外でも対処できる可能性があがります。

２、他人のコードを読む。

今まで、沢山コードを書かれていると思います。作るのが楽しかった。僕もそうでした。

次のステップに行く為には他人のコードを読む事です。そして真似る。

・用いている変数名

・条件分岐

・オブジェクト指向

これらの項目にフォーカスして読むと良いでしょう。

メリット:

・命名規則を知る事が出来る。

→曖昧な分野なのでコーディングして良い命名があればどんどん真似する。

・アルゴリズムを知る事が出来る

→コードの中で最も十人十色な所。世界には自分よりも効果的な書き方をしている人が沢山います。そして真似する。

・フレームワークを読むとコーディング規約の実装例がわかりやすい。そして、カスタマイズできる様になる。

→例えばWordpressをリーディングすれば、カスタマイズしてCMSからSNSの様な動きにする事も可能です。そして、何よりもコーディング規約に準拠した奇麗なコードである場合がほとんどなので、ブログなどに載ってるコードよりも読む価値がある(と思っています)。

３、書く。

とにかく書く事です。プログラミングは体で覚える物です。

１と２で学んだ事を生かす事が出来ればOKです。

もっと効率的なやり方は無いかと疑いながらやるといいです。

４、公開する。

最後は公開しましょう。見せるは一時の恥です。

そして沢山、指摘をもらいましょう。2度同じミスをしなけりゃいい。

さて、とても簡単な４つのアクションを紹介しました。

これで貴方は僕の様に上司にコードを見せた時「なんだこのスパゲティ」と言われる危険性を取り払う事が出来るのではないでしょうか。

ね？簡単でしょう？