1. JavaScript で関数名を補完してほしい
Aptana のような IDE を使っていた、一番助かる機能は、関数名を覚えておかなくて済むこと。
JavaScript や Ruby のような動的な型付けの言語を、シンプルなテキストエディタ一本でガシガシと書く人もいる。自分は、そんなことはとても無理。メジャーな関数名ですら、すぐに忘れてしまう。 (+_+) IDE から入った世代なので、IDE のサポートなしではコードを書けない。
Aptana で関数名を補完してくれる機能を、コードアシストと呼ぶ。
Aptanaの使い方解説 によると、
コードアシスト機能によって、コードの入力中にポップアップウインドウが表示され、入力を補完してくれます。…
コードアシストで自分のコードを利用するには、AptanaのScriptDocツールに記録される必要があります。
2. 自分で定義した関数もコードアシストしてくれる
自分で定義した関数名を補完してもらうには、関数の説明の冒頭に、
/**
を記述する。アスタリスクを一つ余分に書くと覚えておく。
Setting up Code Assist using ScriptDoc – Aptana の Documenting your code using ScriptDoc によると、
Enclose each documentation block within a slash-asterisk-asterisk (/**) and asterisk-slash (*/) comment set.
詳細は、以下を参照。
関数を記述する例
例えば、引数を加算する関数の場合なら、
/**
* 引数を加算した結果を返す
* @param {Number} a
* @param {Number} b
* @return {Number}
*/
var add = function(a, b){
return a + b;
};
これにより、以下のように補完してくれる。
まとめ
とりあえず、最低限覚えておくことは以下の通り。
- コメントの最初を /** で始める
- はじめは全体の説明
- 書き方の形式
- タグ名 {型} 仮引数 説明
- タグの種類
- @param : 引数の説明
- @return : 返り値
