19

このようなものを書くことは有効なJavaScriptです：

function example(x) {
    "Here is a short doc what I do.";
    // code of the function
}

文字列は実際には何もしません。JavaScriptで自分の関数をこのようにコメントしてはいけない理由はありますか？

質問をしている間に私が考えることができる2つのポイント：

  • 文字列リテラルを開始する必要がありますが、これは長期的にはコストがかかる可能性があります

  • 文字列リテラルは、JSミニファイアによってリムーバブルとして認識されません

他に何かポイントはありますか？

編集：このトピックを取り上げた理由： John Resigのブログでこのようなものを見つけました。新しいECMA5標準では、割り当てられていない文字列リテラルを使用して「厳密モード」を有効にしています。今、そのような文書化を行うことに使用または危険があるかどうかを評価することが私の興味でした。

4

2 に答える 2

15

Javascriptでこれを行う意味はありません。Pythonでは、文字列は__doc__関数、クラス、またはモジュールのメンバーとして使用可能になります。したがって、これらのdocstringは、内省などに使用できます。

Javascriptでこのような文字列を作成する場合、コメントを使用するよりもメリットはありません。さらに、文字列が常に存在するなど、いくつかの欠点があります。

于 2009-11-09T21:23:35.693 に答える
1

\ nを散らかすことなく、コードに複数行の文字列を追加する方法を探していました。このモジュールは法案に適合しているようです： https ：//github.com/monolithed/ doc

残念ながら、コメントは縮小化されても存続しませんが、コンパイルタスクを記述してdocstringを「\n」形式に変換できると思います。

于 2014-07-05T15:53:52.430 に答える