概要

初めてのコード規約作成➀

この記事では、コード規約について簡単に説明します。

コード規約とは

コード規約とは、ソースコードを記述する際に則る規約で、コーディング際の共通の認識となるものです。

例えば、ディレクトリ構成やファイル、関数などの命名規則が挙げられ、特にチーム開発をするうえで定められます。

コード規約を定める目的は以下の三つが考えられます。

柔軟な書き方が可能なプログラミング言語を使用してソースコードを記述する場合、プログラマ個人の個性がソースコードに反映されます。

このプログラマの個性を抑えて、一貫性のある記述をすることでソースコードの可読性を向上させます。

例えば yaml ファイルで以下の記述は同様の意味を表します。

isSpace: true

isSpace: yes

isSpace: on

一見、柔軟な書き方をすることが可能なため便利そうに見えますが、これはチーム開発をするうえでは障害になる、プログラマの個性につながります。

実際に書き方を統一ていないチームと統一したチームのコードがそれぞれ以下の通りとします。

統一していない

isAscii:     yes
isLower:     on
isNumber:    true
isPrintable: no
isSpace:     off
isUpper:     false

統一している

isAscii:     true
isLower:     true
isNumber:    true
isPrintable: false
isSpace:     fasle
isUpper:     false

比較してみるとどちらのコードが可読性が高いか一目瞭然ですね。

このように、コード規約によって開発者の個性を抑えて一貫性の記述をすることで可読性が向上します。

長期的な開発を進めていくうえで似たようなふるまいをする関数などが複数作成されたり、俗人化したコードが作成されたりします。

しかし、コード規約によって特定のふるまいする関数がどこに存在するのか明確になり、かつ、コードの俗人化を抑制することができるため、保守性が向上します。

ソースコードに変更を行う際に、意思決定を迅速に行うことが可能になり、コミュニケーションコストを削減することが可能になります。

例えば、コード規約が定められていない場合と定めらている場合について考えてみます。

コード規約が定められていない場合、プロジェクトのディレクトリ内に新たにディレクトリやファイルを作成する際に、チームメンバーに確認してから作成したり、コードレビューの際に議論をしたりと何かとコミュニケーションが発生します。

一方、コード規約が定められている場合は、個人での意思決定が可能となり、確認やコードレビューの際に発生するコミュニケーションコストを削減することができます。

今回はコード規約とは何かと、コード規約を定める目的を記述しました。

次回はどんな技術のどの部分に適応させたかを記述します。