search

hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

Not formatting function comments #100

Closed Remscar closed 3 years ago

Remscar commented 3 years ago

Hi i've been using this plugin but have found that it won't auto-format function comments for me.

For instance i'll have code like this:

  /**
 @notice does a thing
  */
  function doThing(
    uint256 number
  ) external;

But it won't indent the @notice to match the indentation with the rest of the comment. Can't figure out what i'm doing wrong, everything else is working properly and I see there is code in the repo for handling comments, but it just doesn't seem to be running.

hosseinmd commented 3 years ago

Your function has syntax error

Remscar commented 3 years ago

@hosseinmd Sorry that my sample code had a syntax error, I have fixed it. The bug happens whether the function has an error in it or not.

I realize that i filed this issue in the wrong GitHub. Please disregard