読者です 読者をやめる 読者になる 読者になる

JavaScriptでの開発の可読性を高める

これがベストプラクティスという訳ではありませんが、
JavaScriptで開発する際に可読性を高めるいくつかのポイントを示します。

ネームスペースを分ける

クラス(prototype)を作るだけでなく、きちんとネームスペースを分けてパッケージを切りましょう。
たとえば、Connectというクラスがある場合testproject.util.io.Connectなどときちんとパッケージをきります。
全体のコードサイズが肥大化しても比較的可読性が失われずにすみます。
Javaのようにディレクトリ構造とパッケージ構造をあわせ、プログラムによって結合する事も有用です。

クラスの定義にJson形式を用いる

クラスを作る際にJson形式を使うことは可読性をあげる上で有用です
たとえば下記は

var pt = Hoge.prototype;
pt.method1 = function(){
}
pt.method2 = function(){
}
delete pt;

下記のように書くことが可能です

Hoge.prototype = {
	member  : undefined,
	method1 : function(){
	},
	method2 : function(){
	}
}

prototype.jsのClass.createのようなものを使うとコンストラクタの書き方も統一できてよいでしょう。
ただし、好みの問題があるので、必ずしもJson形式での定義が正しいわけではありません。

JavaDocを使う

実際にはJavaDocではありませんが、JavaDoc形式でメンバーに対してコメントを入れましょう
とくに引数や戻り値として使われる動的データオブジェクト(JsonのようにArray,Objectを利用したデータ構造体)の構造や入ってくるデータののきまりごとの他、@var、@param、@returnに型を記述しておくことも後々の助けになります。
とくにグループでの作業の場合には、統一されたコメントスタイルは開発の助けになるでしょう。
動的データオブジェクトは非常に強力な機能ですが、同時にコメントがないと他人には把握できない(自分でも期間がたったら分からなくなる)ものであることを認識すべきです。
最も悪なのはコメントを一切書かないことです。



他にも色々ありますがとりあえず