任意のプログラムの設計で、コードを書くときに、プログラミング規則を使用することが重要です。これは、一貫性のあるコードを見てに役立つだけでなく、(と1人の希望は、特定のバグを回避)するだけでなく、別のプログラマが同じコードで作業することができます。
Altキーフレームワークも例外ではありませんので、私は、私はJavaScriptのためのプロジェクト全体で使用しています規則の概要を説明したいと考えています。(私は、Javaコードのための標準のJavaコーディング規約を使用しています)。
これらの規則はガイドラインではなく、要件で、好ましくはすべてのルールが満たされる必要がありますが、慣例を破るために良識があるとき場合があります。
ファイル/モジュールの構造
AltServletは、 その組織とのある程度の提供 モジュールシステムを、私はそれを言うために、さらにいくつかの手順を移動します。
- 各クラスは、同じ名前の独自のファイルにする必要があり、かつわかりやすいパッケージ内にあるべきです。例えば、SQLSchemaクラスはalt.squealパッケージであるため、ファイルALT /鳴き/ SQLSchema.jsで見つけることができます。
- スクリプトは、必要に応じて、スクリプトの唯一の最小数を要求すべきです。
- ワイルドカードモジュールを使用すべきではありません必要。(IE Alt.require( "ALT。*")。)
構文
構文規則は、Javaの規則に似て書かれています:
- 4-空間ソフトタブ(またはハードタブ)
- オプションのセミコロンは必ず含まれなければなりません。
- オープン中括弧は(例えば、のために、しばらく、もし、などなど)その文と同じ行にする必要があります。
- オプションのシングルの文ブロックの周りの中括弧は除外しなければならない(しばらく、ため、場合、しかし切り替えない、してみてください、またはキャッチ)。if文は、1つのまたは複数のelse文と合わせて、ブロックの一つは、中括弧を持っている場合は(彼らは、オプションの方にも)、その後、すべてのブロックは中括弧を持つ必要があります。
- ホワイトスペースは、アイデアを分離して、コードを読みやすくするために惜しみなく使用する必要があります。
スタイル
それは物事を行うには、いくつかの方法を提供していますので、JavaScriptが強力です。
- 匿名関数は、指定すべきではありません。(「arguments.calleeのは、」無名関数で再帰呼び出しのために使用することができます。)
- 内側の機能が十分であればグローバル関数を避けてください。
- 常にローカル変数VARを使用しています。
- 特に長い関数で、コードの複雑なビットを説明するコメントを使用してください。
- 常に彼らが考慮されていても、機能にjsdocsを置く「プライベート。」すべてのパラメータ、例外、および戻り値を文書にしてください。
- クラスは、可能な限り(代わりの変数に無名関数を割り当てる)標準の名前の関数の構文で定義する必要があります。
- クラスの機能は、他の一方で、無名関数の構文でプロトタイプオブジェクトのメンバーとして定義されなければなりません。
- クラスの継承は以下のように定義される:SubClass.prototype =新しいBaseClassの。
- スーパークラスのコンストラクタは(とすべきである)Function.callメソッドを呼び出すことができます。
コピー:http://alt.cellosoft.com/js-conventions.html
参照 http://www.cnitblog.com/alsan/articles/8069.htmlの 詳細については。
ます。https://www.cnblogs.com/jalenwang/archive/2012/02/26/js-convertion.htmlで再現