C#のコーディングルール:スタイルコップアナライザーを使ってチーム全員が同じコードを書く方法
What you'll learn
- C#のコーディングルールがわかる
- チーム全員が統一したコードを書く方法がわかる
- スタイルコップアナライザー(StyleCopAnalyzers)の使い方がわかるようになる
- スタイルコップアナライザーで非表示にする警告がわかる
- スタイルコップアナライザーで表示するべき警告がわかる
Requirements
- C#でif文が書ける程度の知識
Description
この講座では,C#でチーム全員が統一したコードを書くためのコーディングルールを解説しています。
マイクロソフトには昔からコーディングルールのガイドラインが公開されており,
C#で提供されているライブラリー等はすべてそのガイドラインに沿ったコーディングがされています。
我々も,マイクロソフトのコーディングルールを習得することで
チーム全員が統一したコードが書けるようになり,
名前の付け方や,「コンストラクタ」や「プロパティ」を書く順番が統一されます。
さらにスタイルコップアナライザーという無料のツールを使うことで
それらのルールに従っていない場合に警告を出すことができ,
チームのメンバーが,自然とルール通りにコーディングできるようになる
ツールの使い方を詳細に解説しています。
これにより,「コンストラクタ」と「プロパティ」はどちらを先に書くか?などのレベルは
スタイルコップアナライザーに任せて,我々はもっと重要なコードにコードレビューの時間を充てることができます。
目次
#01_はじめに
#02_名前の付け方
#03_名前付けのガイドライン
#04_パスカルケースとキャメルケース
#05_パスカルとキャメルの内訳
#06_パスカルとキャメルの実演
#07_2文字の略語は大文字にする
#08_名前空間のガイドライン
#09_ローカルルールについて
#10_private変数にアンダーバーを付ける
#11_コントロールの名付け
#12_クラス名とファイル名の名づけ
#13_StyleCopAnalyzersについて
#14_StyleCopAnalyzersのインストール
#15_ネームスペースの調整
#16_SA0001_プロパティのビルドのXMLでファイルを指定しておくと消える
#17_CS1591_XMLコメントなし
#18_SA1101_thisが付いていない
#19_不要なルールを非表示にする方法
#20_SA1200_usingの場所
#21_SA1400_アクセス修飾子が明示的に定義されていない
#22_その他不要なルールを非表示
#23_コンストラクタとデストラクタを作成
#24_Private変数とパラメータ変数の命名
#25_中括弧の省略禁止と改行
#26_コメントはスラッシュ4つ
#27_プロパティのXMLコメント
#28_コンストラクタやプロパティの書く順番
#29_アクセスレベルを加味した書く順番
#30_インタフェースのIとファイル名の不一致
#31_最後に
Who this course is for:
- C#初心者
- C#をチーム開発していてコードが統一されていない技術者
- C#のコーディングルールを学びたい人
- C#できちんとしたコードを書きたい人
Instructor
20年ほどプログラマーとして活動しています。初期の頃はいろんな現場を転々とするプログラマーで10年ほど経験をつみ,その後,大手メーカーに入社し,C#やSQLServerを中心とした製品開発にて設計,製作,保守,プロジェクトリーダー等を10年近く担当。
知識習得のきっかけは,現場に分かりづらいプログラムコードが散乱しており,それらをわかりやすくするために,オブジェクト指向,ドメイン駆動開発,テスト駆動開発,リファクタリング,デザインパターンの書籍などを読み漁りました。その結果,一つのドメイン駆動開発手法にいまはたどり着き,チームのメンバーに伝えていますが,この知識を大勢の方にお伝えすると,予想以上に喜んで頂けているので,私の学んだ知識をできるだけわかりやすくお伝えして,私のした遠回りをあまりしなくてもいいように,解説していきたいと思っています。