個人コード仕様の共有
1720 ワード
概要
今日私は何気なく1篇のコードの規範を書くブログを見て、深く啓発されて、そこで自分のコードを書く規範を総括することを決定して、記録して、後で開発する時参考にして、他の人に対しても役に立つと信じています.
参考資料:
個人コード仕様の共有
変数の長さ
変数名は省略せず、変数の長さを制限しません.(エディタに自動補完機能があるので、長く書いても大丈夫ですが、重要なのは意味を伝えることです)
変数の名前付け
1.変数単語コネクタ
単語コネクタ(and)を使用しないで、アルパカ式の名前を使用します.たとえば、次のようにします.
2.ブール値変数
3.リストクラス変数
4.辞書変数
5.循環体一時変数
6.データ変数
ネットワークから要求されたデータ、または前処理されたデータは、
関数の名前付け
1.操作クラス関数
一般的に動詞+形容詞/名詞を使います.
2.データクラス関数の取得
3.ネットワークからのデータクラス関数の取得
4.イベント応答クラス関数
次の2点に注意してください.その他の関数は、 ではありません.実際の状況を見て、buttonが1つしかない場合はhandleClickを直接使えばいいです.複数ある場合は、handleCancelClick()、handleCloseClick()、handleCloseClick();handleIsEnabledChange() など、複数の単語を追加して区別する必要もあります.
その他命名が終わった後、しばらく止まって、この命名が他の人に理解できるかどうかを反省します. データ前処理方法の命名:preProcessData()
今日私は何気なく1篇のコードの規範を書くブログを見て、深く啓発されて、そこで自分のコードを書く規範を総括することを決定して、記録して、後で開発する時参考にして、他の人に対しても役に立つと信じています.
参考資料:
個人コード仕様の共有
変数の長さ
変数名は省略せず、変数の長さを制限しません.(エディタに自動補完機能があるので、長く書いても大丈夫ですが、重要なのは意味を伝えることです)
変数の名前付け
1.変数単語コネクタ
単語コネクタ(and)を使用しないで、アルパカ式の名前を使用します.たとえば、次のようにします.
btnSaveClick
2.ブール値変数
is
の先頭を使用します.たとえば、次のようにします.isEnable
isVisible
3.リストクラス変数
List
の末尾を使用します.たとえば、次のようにします.foodList
documentList
4.辞書変数
Dic
の末尾を使用します.たとえば、次のようにします.openWithDic
exeDumpDic
5.循環体一時変数
item
の末尾を使用します.たとえば、次のようにします.documentItem
6.データ変数
ネットワークから要求されたデータ、または前処理されたデータは、
Data
の末尾を使用します.たとえば、次のようにします.xAxisData
segmentsData
関数の名前付け
1.操作クラス関数
一般的に動詞+形容詞/名詞を使います.
save()
deleteHospital()
saveAllProducts()
2.データクラス関数の取得
get
の先頭を使用します.たとえば、次のようにします.getDocumentList()
getElementById()
3.ネットワークからのデータクラス関数の取得
CURD
の先頭を使用して、create、update、read、deleteをそれぞれ表します.例:createUser()
updateRole()
readProject()
deleteIndustries()
4.イベント応答クラス関数
handle
の先頭を使用します.たとえば、次のようにします.handleClick()
handleChange()
次の2点に注意してください.
handle
で始まるその他