Python Docstrings のような JavaScript 関数のコメント化

Question

次のような記述は有効な JavaScript です。

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

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

質問を書いているときに考えられたポイントは次の 2 つです。

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

• 文字列リテラルは、JS ミニファイアーによって削除可能として認識されません。

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

編集： 私がこのトピックを取り上げた理由:でこんなものを見つけました ジョン・レシグのブログ, ここで、新しい ECMA 5 標準では、割り当てられていない文字列リテラルを使用して「厳密モード」を有効にします。さて、私の興味は、そのような文書化を行うことに用途や危険性があるかどうかを評価することだけでした。

Answer 1

JavaScriptでこれを行うにはポイントは本当にありません。 Pythonでは、文字列は、関数、クラス、またはモジュールの__doc__部材として利用可能になります。したがって、これらのdocstringはイントロスペクションなどのために用意されています。

あなたはJavascriptで、このような文字列を作成する場合は、

は、コメントを使用しての上に何の利益を得るていない、プラスあなたは、文字列が常に存在しているように、いくつかの欠点を取得します。

Answer 2

私は、\ n個のとそれをポイ捨てせずに自分のコードに複数行の文字列を追加する方法を探していました。このモジュールは、法案に合うように見えます： https://github.com/monolithed/のドキュメントのの

残念ながら、コメントは縮小に耐えられないだろうが、私はあなたが「\ n」はフォーマットにドキュメンテーション文字列を変換するために、コンパイルタスクを書くことができたとします。