Write JavaDoc the right way

osscameroon / js-generator

Generates JavaScript from HTML

https://osscameroon.github.io/js-generator/

MIT License

18 stars 14 forks source link

Write JavaDoc the right way #248

Open FanJups opened 1 year ago

FanJups commented 1 year ago

Great advice from Ken Fogel

https://twitter.com/omniprof/status/1672328157926391809?t=upNMd6j1_ieYJiEh_HRcww&s=19

For once & for all, JavaDocs for an API without code samples for each & every method, interface, class, etc. is an abomination. When I read documentation that refers me to the API's JavaDocs I know I am in for a disappointment.