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
We have some comments lying around in the frontend code (especially in the Vue SFCs).
We should discuss about refactoring those comments to JSDoc conform comments (see https://jsdoc.app/).
This mimics functionality like JavaDoc for Java-based projects.
Modern IDEs have support for JSDoc. They can help with writing those comments and displaying information contained inside those comments.
On top of that:
This change would allow automatic generation of code documention by including additional tooling.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
We have some comments lying around in the frontend code (especially in the Vue SFCs).
We should discuss about refactoring those comments to JSDoc conform comments (see https://jsdoc.app/).
This mimics functionality like JavaDoc for Java-based projects.
Modern IDEs have support for JSDoc. They can help with writing those comments and displaying information contained inside those comments.
On top of that:
This change would allow automatic generation of code documention by including additional tooling.
Beta Was this translation helpful? Give feedback.
All reactions