js命名規範
5255 ワード
js命名規範
js命名は簡潔、意味化の原則に従うべきである.
一、変数
命名方法:小ラクダ峰式命名法命名規範:プレフィクスは形容詞(関数プレフィクスは動詞であり、これによって関数と変数を区別する)
ネーミング方法:名詞のすべての大文字命名規則:大文字と下線を使って名前を組み合わせ、下線を使って単語を分割します.
命名方法:子供のこぶ式命名法の命名規範:プレフィクスは動詞の命名提案であるべきです.
動詞
意味
can
ある動作を実行できるかどうかを判断します.
ハイ
ある値を意味するかどうかを判断します.
is
ある値かどうかを判断する
get
値を取得
セット
値を設定
ロード
いくつかのデータをロード
クラスのメンバーは以下を含む:共通属性と方法:変数と関数名と同じです. プライベート属性および方法:プレフィクスはアンダースコア
プラグイン推奨prettier 6.1シングル行のコメントをフォーマットします.
コメント名
構文
意味
例
@param
@param{パラメータタイプ}記述情報
パラメータの説明
@param{String}name着信名称
@return
@return{パラメータタイプ}記述情報
戻り値の説明
@retun{Boolean}true:実行可能です.false:実行不可
@author
@author説明情報
説明者
@author某2018/04/24
@example
@exampleサンプルコード
プレゼンテーション関数の使用
@example setTitle(‘ララ啦’);
七、vue常用開発規範
vueスタイルガイドを参照してください.
7.1 import
importは最上階に置くべきで、コンポーネント名を導入して大文字のラクダのピーク式の命名法に従います.
ネーミング方法:関数命名法の提案:イベント処理は
7.3ウォッチを使わず、直接イベントを監督する.
7.4 styleの
js命名は簡潔、意味化の原則に従うべきである.
一、変数
命名方法:小ラクダ峰式命名法命名規範:プレフィクスは形容詞(関数プレフィクスは動詞であり、これによって関数と変数を区別する)
#
let maxCount = 10;
let tableTitle = ' ';
#
let setConut = 10;
let getTitle = ' ';
二、定数ネーミング方法:名詞のすべての大文字命名規則:大文字と下線を使って名前を組み合わせ、下線を使って単語を分割します.
const MAX_COUNT = 10;
const URL = '//www.huifenqi.com';
三、関数と方法命名方法:子供のこぶ式命名法の命名規範:プレフィクスは動詞の命名提案であるべきです.
動詞
意味
can
ある動作を実行できるかどうかを判断します.
ハイ
ある値を意味するかどうかを判断します.
is
ある値かどうかを判断する
get
値を取得
セット
値を設定
ロード
いくつかのデータをロード
//
function canRead() {}
//
function getName() {}
四種類と立体関数class Persion {
constructor(name) {
...
}
}
let person = new Person(' ');
クラスのメンバークラスのメンバーは以下を含む:
_
であり、共通の属性および方法と同様の命名方式である.class Person {
//
_name: string;
constructor() { }
//
getName() {
return this._name;
}
//
setName(name) {
this._name = name;
}
}
六、注釈規範プラグイン推奨prettier 6.1シングル行のコメントをフォーマットします.
//
setTitle()
6.2複数行のコメント/*
* setTitle()
* setTitle(): title
*/
setTitle();
6.3関数と方法コメント/**
*
* @
**/
常用キーワードのコメントコメント名
構文
意味
例
@param
@param{パラメータタイプ}記述情報
パラメータの説明
@param{String}name着信名称
@return
@return{パラメータタイプ}記述情報
戻り値の説明
@retun{Boolean}true:実行可能です.false:実行不可
@author
@author説明情報
説明者
@author某2018/04/24
@example
@exampleサンプルコード
プレゼンテーション関数の使用
@example setTitle(‘ララ啦’);
七、vue常用開発規範
vueスタイルガイドを参照してください.
7.1 import
importは最上階に置くべきで、コンポーネント名を導入して大文字のラクダのピーク式の命名法に従います.
import ElInput form '***'
import Emitter from '***'
7.2 methodsネーミング方法:関数命名法の提案:イベント処理は
handle
で始まり、handleBlur
の他の提案のように、promise
またはasync
/await
を使用して、非同期論理を処理し、コールバック関数の使用を避ける.7.3ウォッチを使わず、直接イベントを監督する.
7.4 styleの
scope
属性を合理的に利用し、ページスタイルを隔離する.汎用コンポーネントはscope
の使用を避けるべきである.