You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently it's possible to write the following code. Notice the space between
the comment and the function its describing. This is perfectly valid, but is
stylistically bad (in my opinion), and I'd like a rule to prevent (and hopefully
auto-fix) this scenario.
/** * This is a description of some function! */functionsomeFunction(){// ...}
Current behavior
There is no such rule.
Desired behavior
I would like a new rule with the following behavior:
This should be considered an error:
/** This is a description of some function!*/functionsomeFunction(){}
These should not be considered errors:
/** This is a description of some function! */// extra commentfunctionsomeFunction(){}
/** Standalone comment (e.g. a type definition) *//** The actual description */functionsomeFunction(){}
This could maybe be done with other rules, but I couldn't find any other rule or combination of rules that would apply specifically to doc comments and not all block comments.
The text was updated successfully, but these errors were encountered:
Motivation
Currently it's possible to write the following code. Notice the space between
the comment and the function its describing. This is perfectly valid, but is
stylistically bad (in my opinion), and I'd like a rule to prevent (and hopefully
auto-fix) this scenario.
Current behavior
There is no such rule.
Desired behavior
I would like a new rule with the following behavior:
This should be considered an error:
These should not be considered errors:
Alternatives considered
This could maybe be done with other rules, but I couldn't find any other rule or combination of rules that would apply specifically to doc comments and not all block comments.
The text was updated successfully, but these errors were encountered: