【C#】自分だけのC#コーディングルールを作った

タイトルの通り、自分用のC#コーディングルールを作成しました。

github.com

背景

自分の頭の中での思考だったり、今までに作ってきたソースコードを見直したりして
一貫性がありませんでした。

自分が気に入った、色んな文献のコーディングルールが頭の中に整理されていない始末。
何かしらの指標が欲しいと思い作成しました。

環境・参考元


Visual Studio Codeで作成しました。Visual Studioと違ってサクサク。
azure.microsoft.com

また、Markdown All in One という拡張機能を使って作成しています。
marketplace.visualstudio.com

それから、かなりの割合で参考にしたコーディングルールが2つ存在します。
github.com
google.github.io

良かった点

ソースコードに一貫性ができる

当たり前ですが、自分の中での明確なルールができるため
書く時に悩む時間が減り、読む時間が減りました。

私の場合、一貫性を持たせるために他のソースコードを見に行く時間を奪われており、
その時間が明確に減ったと思っています。

共有ができる

GitHubで公開しているため、今後他の人と作るときにリンクをぶん投げるだけで
このルールに従って作成が可能になります。

もし誰かが休んだとしてもルールに乗っ取って作っていれば
読む時間を減らし、修正に充てられます。

日本語である

日本語で作られているということは、日本語で作られているということです。
私英語苦手なので…。

悪かった点

ソースコードが書けない

スタイルガイドを自分が満足するまで書ききるのに約1週間
時間にして約10時間程度かけて作成しました。
この時間でどれだけ他の事に費やせたのかと考えると…

表現の言語化が難しい

これまでなんとなく作っていたので、日本語にして書き起こすことが非常に難しいです。 曖昧な表現はできるだけ避け、不明な部分はきちんと調べました。

終わりに

スタイルガイドを書くのは非常に疲れました。 書ききると綺麗に作成されており、非常に自己肯定感が上がり満足しています。

また、Markdownについては
このはてなブログで日々ブログを書いていた知識が使えて良かったです。

これで終わりではなく、このルールを元にして作られていくのを忘れないように
ゲームを作っていきたいです。

参考サイト

編集

Visual Studio Code – コード エディター | Microsoft Azure
Markdown All in One - Visual Studio Marketplace

コーディングルール

C# at Google Style Guide | styleguide
GitHub - DotNetAnalyzers/StyleCopAnalyzers: An implementation of StyleCop rules using the .NET Compiler Platform
Nasan_UnityStyleGuide/CSharpStyleGuide.md at main · nasan730/Nasan_UnityStyleGuide · GitHub