@stylistic/js/

line-comment-position

行コメントは、コードの上または横に配置できます。このルールは、チームが一貫したスタイルを維持するのに役立ちます。

// above comment
var foo = "bar";  // beside comment

ルールの詳細

このルールは、行コメントの一貫した位置を強制します。ブロックコメントはこのルールの影響を受けません。デフォルトでは、このルールは、次の単語で始まるコメントを無視します：eslint, jshint, jslint, istanbul, global, exported, jscs, falls through。

オプション

このルールは、文字列またはオブジェクトのいずれかの引数を取ります。文字列の設定は、positionプロパティ（以下で説明）と同じです。オブジェクトオプションには、次のプロパティがあります。

position

positionオプションには2つの設定があります。

• above（デフォルト）は、コードの上、それ自身の行にのみ行コメントを強制します。
• besideは、コード行の末尾にのみ行コメントを強制します。

position: above

{ "position": "above" }オプションの正しいコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "position": "above" }]*/
// valid comment
1 + 1;

正しい

{ "position": "above" }オプションの不正なコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "position": "above" }]*/
1 + 1; 
// invalid comment

不正

position: beside

{ "position": "beside" }オプションの正しいコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "position": "beside" }]*/
1 + 1; // valid comment

正しい

{ "position": "beside" }オプションの不正なコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "position": "beside" }]*/
// invalid comment
1 + 1;

不正

ignorePattern

デフォルトでは、このルールは、次の単語で始まるコメントを無視します：eslint, jshint, jslint, istanbul, global, exported, jscs, falls through。代替の正規表現を提供できます。

ignorePatternオプションの正しいコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "ignorePattern": "pragma" }]*/
1 + 1; // pragma valid comment

正しい

ignorePatternオプションの不正なコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "ignorePattern": "pragma" }]*/
1 + 1; 
// invalid comment

不正

applyDefaultIgnorePatterns

ignorePatternが指定されている場合でも、デフォルトの無視パターンが適用されます。デフォルトのパターンを省略する場合は、このオプションをfalseに設定します。

{ "applyDefaultIgnorePatterns": false }オプションの正しいコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "ignorePattern": "pragma", "applyDefaultIgnorePatterns": false }]*/
1 + 1; // pragma valid comment

正しい

{ "applyDefaultIgnorePatterns": false }オプションの不正なコードの例

/*eslint @stylistic/js/line-comment-position: ["error", { "ignorePattern": "pragma", "applyDefaultIgnorePatterns": false }]*/
1 + 1; 
// falls through

不正

非推奨：オブジェクトプロパティapplyDefaultPatternsは非推奨です。代わりに、プロパティapplyDefaultIgnorePatternsを使用してください。

使用しない場合

異なる行コメントスタイルを持つことを気にしない場合は、このルールをオフにできます。

互換性

JSCS: validateCommentPosition