気まぐれな備忘録(仮)

いちようSEしてるので、プログラミングの備忘録的なものを書いてます

まずはコーディング規約を学ぶ

こんにちは。kajitilunaです。

新人/若手向け、これだけは知っとけTips25 Advent Calendar 2012
の14日目の小ネタを。


チームでのシステム開発に関わると、
コーディング規約について聞いたことや、
あるいはいやいや従わされたことがあると思います。

または、ある程度しっかりしたチームや組織だったら、
研修などで叩き込まれることと思います。


今回は、
システムのちょっとしたツールを作って、とか言われて、
それをシステムのメインとは別の言語で作るんだけど、
自分その言語に詳しくないぞ、、、といったケースを考えます。

前提

  • インデントを揃えて見やすくする。
  • その処理を端的に言い表す単語を用いる。
  • 名詞、動詞、形容詞を使い分ける。
  • ローマ字表記な名前付けを避ける。

、、、など、後々見る人にとって分かり易いものを心がける気持ちが必要です。

要は他人への思いやり、いや、むしろ明日の自分への思いやりです。

それがないとコーディング規約を守る、というレールに乗らないので。


チーム、組織にその言語のコーディング規約が存在しないか確認

ええ。いわずもがなでございます。
そして大半の場合、チームの誰も知らないのが世の常でございます。

ググる

言語名と「コーディング規約」という単語合わせでググってみましょう。
チームが頼りにならないのならグーグル先生に頼りましょう。

チームの規約がないのであれば、世間一般的なしきたりに従ってください。

JavaC++, C#などはエンタープライズ開発で頻繁に扱われるので、たくさんヒットします。
JavaScriptVBScriptなどは言語のクセが強いので、特有のルールがあります。

これらに従えば、たいてい失敗はしません。

規約の遵守率=プログラムの品質

経験上、こう言っちゃってもいいくらいです。

一般的な規約に従っていないコードは、
その言語に疎い人が作った可能性が高く、不具合も多い傾向にあります。
少なくても、規約を守っていないけど設計がちゃんとしている、ようなコードには
一度も出会ったことはありません

そもそも、コーディング規約そのものが不具合を回避するための指針なので。


ちなみに私自身、そういったコードに出会ったときは、
品質を疑って中身をチェックするようにしています。

逆に、言語にあまり慣れていなくても、
その言語の規約に従えば、その言語の扱い方が(なんとなくですが)身に付きます。

ということで

初めて扱う言語は、文法と一緒に規約を学んでみましょう。