udemyの動画を視聴してアウトプットをかねて学んだことをまとめてみました。
駆け出しのエンジニアで、実力はまだまだですか記事を書いてみました
今回は「C#のコーディングルール:スタイルコップアナライザーを使ってチーム全員が同じコードを書く方法」という動画をみてアウトプットを行いました。
1、「コーディングにおける名前付のルール」
・命名は英語でつける。
・基本的にはPascal型で書く。Pascalとは、頭文字は大文字で書くという意味。
(二句の英単語ならUserNameと言うように格句を大文字にして書く。)
・プロジェクト名は、例えば製品名のようにアイテムの名前を記載。
名称:(ex:ps4)
・ソリューション名はアイテム名.用法というように記載。
用法:(ex:ps4.説明書)
・二文字の略語は大文字にする。
IE (ex:Internet Explorer)
・三文字の略語の場合は先頭だけ大文字にする。
Sql(Structured Query Language)
・例外(2つのみ)
・identifier →id
・Okay →Ok
2.「名前空間の決め方」
会社名+製品名+プロジェクト名+フォルダ名
・ローカルルール(マイクロソフトで規定されていない物)
→チームで統一されてれば良いルール。
・動画内で推奨されていたルール。
private変数はアンダーバーをつける。
(ex:_userName)
→thisの代わりにアンダーバーをつけると表示がわかりやすい。。
・コントロール名の名付け方
最後にコントロール名をつける。
ボタンの時:SaveButton
テキストボックスの時:ProductNameTextBox
・クラス名・ファイル名の付け方。
語尾に種類をつける。
ex)ProductListForm
3.「StyleCop.Analyzersの使い方」
StyleCop.Analyzersとは、VS上で使用する
コーディングルールの誤りを警告する拡張ツール。
・警告が番号でエラーウィンドウに出る、
(ex:SA--)
・不要なルールと感じれば、該当警告の部分を選択し非表示にする、
・class作ったらxmlコメントとアクセス修飾を記載する。
・if文等で中括弧{}を使用した際、もう一度使う際は一行開けて次の中括弧を使用する。
・メソッドの中にコメントは避ける。どうしても描きたい際はスラッシュは4つ書く。。
・「アクセスレベルの順番」
public→internal→protected internal→protected→private
の順番で記載する。
以上で学んだことのまとめを終わります。
今回初めてのQiita執筆となりました。
これからも継続的にアウトプットかねてエンジニアとしてより高みを目指していきたいと思います。
もしよろしければ励みになりますため、LGTMをお願いします