@stylistic/js/

multiline-comment-style

多くのスタイルガイドでは、複数行にわたるコメントに対して特定のスタイルが求められます。たとえば、複数行コメントに単一のブロックコメントを使用することを推奨するスタイルガイドもあれば、連続した行コメントを推奨するスタイルガイドもあります。

ルールの詳細

このルールは、複数行コメントに特定のスタイルを適用することを目的としています。

オプション

このルールには文字列オプションがあり、次のいずれかの値を設定できます。

• "starred-block" (デフォルト): 連続した行コメントを禁止し、ブロックコメントを推奨します。さらに、ブロックコメントの各行の先頭にアスタリスク(*)文字を揃えて配置する必要があります。
• "bare-block": 連続した行コメントを禁止し、ブロックコメントを推奨します。また、ブロックコメントの各行の先頭にアスタリスク("*")文字を付けることを禁止します。このオプションはJSDocコメントを無視します。
• "separate-lines": ブロックコメントを禁止し、連続した行コメントを推奨します。デフォルトでは、このオプションはJSDocコメントを無視します。JSDocコメントにもこのルールを適用するには、`checkJSDoc` オプションを `true` に設定します。

このルールは、`/* eslint-disable */` などのディレクティブコメントは常に無視します。

デフォルトの "starred-block" オプションでこのルールに違反するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "starred-block"] */

// this line
// calls foo()
foo();

/*
 this line
calls foo() */

foo();

/*
 this comment
 * is missing a newline after /*
 */

/*
 * this comment
 * is missing a newline at the end 
*/

/*
* the star in this line should have a space before it
 */

/*
 * the star on the following line should have a space before it
*/

不適切なコード

デフォルトの "starred-block" オプションでこのルールに準拠するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "starred-block"] */

/*
 * this line
 * calls foo()
 */
foo();

// single-line comment

適切なコード

"bare-block" オプションでこのルールに違反するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "bare-block"] */

// this line
// calls foo()
foo();

/*
 * this line
 * calls foo()
 */
foo();

不適切なコード

"bare-block" オプションでこのルールに準拠するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "bare-block"] */

/* this line
   calls foo() */
foo();

適切なコード

"separate-lines" オプションでこのルールに違反するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "separate-lines"] */

/*
 This line
calls foo() */
foo();

/*
 * This line
 * calls foo()
 */
foo();

不適切なコード

"separate-lines" オプションでこのルールに準拠するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "separate-lines"] */

// This line
// calls foo()
foo();

適切なコード

"separate-lines" オプションと checkJSDoc を true に設定した場合にこのルールに違反するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "separate-lines", { "checkJSDoc": true }] */

/*
*
 * I am a JSDoc comment
 * and I'm not allowed
 */
foo();

不適切なコード

"separate-lines" オプションと checkJSDoc を true に設定した場合にこのルールに準拠するコードの例

/* eslint @stylistic/js/multiline-comment-style: ["error", "separate-lines", { "checkJSDoc": true }] */

// I am a JSDoc comment
// and I'm not allowed
foo();

適切なコード

使用しない場合

複数行コメントに特定のスタイルを適用したくない場合は、このルールを無効にすることができます。