Blog

COCONEスタイルガイド

こんにちは、cocone tech blog編集長のYです。

突然ですが、チームでアプリケーションを開発する上で大切なものはなんでしょう?

コミュニケーションを取ること?進捗の共有?思いやりの気持ち?

どれも大切ですが、チームで開発をするうえでとても重要なものとしてコーディング規則がありますよね。

ということで今回は、ココネ株式会社が実際に使用している各言語のスタイルガイドについてご紹介しようと思います!

COCONEスタイルガイド

早速ですが、ココネが採用しているスタイルガイドはこちらになります。

https://github.com/coconecorp/styleguide.git

 

掲載している言語は

  • C#
  • Go
  • Java
  • Kotlin
  • HTML/CSS
  • TypeScript/JavaScript
  • TypeScript

となります。

 

C#の例

全てをご紹介するのは難しいので、この記事内ではC#のコーディング規則の一部をご紹介します!

名前付け規則

Pascal形式

  • 【必須】classrecordstructの名前を付ける場合は、Pascal形式(”PascalCasing”)を使用しなければなりません。
// classの指定
public class DataService
{
}

// recordの指定
public record PhysicalAddress(
    string Street,
    string City,
    string StateOrProvince,
    string ZipCode);

// structの指定
public struct ValueCoordinate
{
}

 

Camel形式

  • 【必須】privateまたはinternalのフィールドに名前を付ける場合は、Camel形式(”camelCasing”)を使用しなければなりません。
public class DataService
{
    private IWorkerQueue workerQueue;
}

LINQクエリ

  • 【推奨】クエリ変数にはCamel形式(”camelCasing”)の使用を推奨します。
var seattleCustomers = from customer in customers
                       where customer.City == "Seattle"
                       select customer.Name;

コーディング規則を定める理由

ではいったいなぜコーディング規則が必要なのでしょうか?

コーディング規則はプログラムの「保守性」と「品質」を高めることができます。

プログラムの「保守性」とは、プログラムが正常な状態を維持するように保つことです。

コーディング規則によって統一することで、誰もが内容を理解しやすくし、バグや間違いを発見しやすくなります。

 

また、コーディング規則により、あらかじめバグが少ないコードを使用するようになるため、結果としてバグの少ない「品質」の高いプログラムを書くことができます。

コードレビューの際にもコーディング規則を守っているかを誰からでも確認することができるので、ミスを防ぐこともできます。

さらに、人によってはコーディング規則に従う事で今までに経験がない方法での開発となり、経験を積むことができるという利点もあります。

 

以上のような理由からコーディング規則を定め、ココネでは各言語毎のコーディング規則に従って開発をしています。

おわりに

いかがでしたか?

個人開発でもチーム開発でもコードの理解のしやすさ、見やすさというのは開発を効率的に進める上でとても重要で、そのためにコーディング規則を定めるのは良いことだと思います。

少しでもこのココネのスタイルガイドがコーディング規則を定める際の参考になれば幸いです。

 


 

ココネでは一緒に働く仲間を募集中です。

ご興味のある方は、ぜひこちらの採用特設サイトをご覧ください。

https://www.cocone.co.jp/recruit/contents/

Category

Tag

%d人のブロガーが「いいね」をつけました。