@stylistic/

複数行コメントスタイル

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

ルールの詳細

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

オプション

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

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

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

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

/* eslint @stylistic/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/multiline-comment-style: ["error", "starred-block"] */

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

// single-line comment

正しい

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

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

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

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

誤り

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

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

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

正しい

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

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

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

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

誤り

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

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

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

正しい

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

/* eslint @stylistic/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/multiline-comment-style: ["error", "separate-lines", { "checkJSDoc": true }] */

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

正しい

使用しない場合

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