我要开始魔鬼排版了。按点列出自己需要注意的部分。
- 为了区分标识符中的单词,将每个单词的首字母大写,不要用下划线来区分单词,也不要在标识符的任何位置使用下划线。
- 除参数以外的标识符,将每个单词的第一个字符大写,如,HtmlTag;如果是两个字母的首字母缩略词,两个字母都大写,如,IOStream
- 作为参数的标识符,除了第一个单词以外的每个单词的首字母大写,如,ioStream
- 名称不要仅通过大小写来区分,不假定所有的编程语言都区分大小写。
- 不要使用缩写或者缩写作为标识符的一部分
- 不使用任何未被广泛接受的首字母缩写词
- 不要为类名称指定前缀
- 使用字母I为接口加前缀
// 対象
// 名前空間
// 型
// InterFace
// 方法
// 属性
// 事件
// field
// 枚举
// 対象
// 参数
// ④ 単語の頭文字をとった場合は大文字
// 2文字の場合
// Internet Protocol ⇒ IP
// No good ⇒ NG
// 3文字の場合
// Transmission Control Protocol ⇒ Tcp
// Structured Query Language ⇒ Sql
// 例外 頭文字2文字での略語は例外
// Identifier ⇒ Id
// Okey ⇒ Ok
// ⑤ namespace作成規則
// 会社名+製品名+プロジェクト名+フォルダー名
// プロジェクト名 WinForm とか WPFとか LIB
// ⑥ private変数名に_をつける
// _userName
// メソッド内の変数とクラス変数が区別できる
// アンダーバーを打ち込むとインテリセンスにクラス内変数のみが表示される
// ⑦ 控件后面加上类型
// ProdctNameButton ⇒ Button
// ProdctNameTextBox ⇒ TextBox
// ProdctNameCheckBox ⇒ CheckBox
// ProdctNameLabel ⇒ Label
// インテリセンスによって区別ができる
// ⑧ クラス名(ファイル名)
// 語尾に種類をつける
// SaveFrom
// SaveViewModel
// SaveEntity
// ⑨ StyleCop.Analyzersをインストールして自動でプログラムをチェックする
// 1.プロジェクト⇒ プロパティ ⇒ NuGetパッケージの管理 にて 入手
// 2.プロジェクト⇒ プロパティ ⇒ コード分析 ⇒ リストBOX「この規則セットを実行」⇒「参照」 ⇒ 配布した「CsCodingRules.ruleset」を選択
// 3.SA001⇒プロジェクト⇒プロパティ⇒ビルド⇒XMLドキュメントファイルにチェック
// 4.各警告を消していく