jscs-jsdoc icon indicating copy to clipboard operation
jscs-jsdoc copied to clipboard

Add a rule to enforce maximum comment width

Open gajus opened this issue 10 years ago • 0 comments

Add a rule that allows to set a variable maximum width of comment.

This rule is designed to prevent silly long comments, e.g.

/**
 * aaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbcccaaabbbccc
 */

That (depending on the text editor) require that user scrolls the window horizontally to read the entire comment.

Have a sane default, e.g. 70 to encourage consistent width across projects that use JSCS.

Do not forget to consider fullwidth characters. I suggest to use string-width.

gajus avatar Sep 19 '15 01:09 gajus