search

numberscope / frontscope

Numberscope's front end and user interface: responsible for specifying sequences and defining and displaying visualizers
MIT License
7 stars 15 forks source link

Use JSDoc in block comments #180

Open liammulh opened 1 year ago

liammulh commented 1 year ago

In one of the student meetings, it was brought to our attention that having the tooltips that some editors and IDEs generate when there's a block comment above a function with JSDoc @param @returns etc. directives is useful. We should either require or highly recommend adding JSDoc directives in block comments.

gwhitney commented 1 year ago

Would this be a requirement for all exported identifiers from a given file? (And optional for unexported ones?) Can a list of the required/optional JSDoc tags be added in the documentation along with instituting this requirement?

liammulh commented 1 year ago

I think having the descriptions for@param and @returns would be nice.

liammulh commented 1 year ago

Would this be a requirement for all exported identifiers from a given file? (And optional for unexported ones?)

Seems reasonable to me.